This week's book giveaways are in the Refactoring and Agile forums.
We're giving away four copies each of Re-engineering Legacy Software and Docker in Action and have the authors on-line!
See this thread and this one for details.
Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Agile forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Autogenerating Javadoc skeleton comment blocks

 
benjamin van der veen
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I think I may have committed a deadly sin. I didn't javadoc-comment my code as I wrote it.

Now I'm sitting on close to 50 undocumented files (though not all of them are "public" and require javadoc). I am wondering if there is any software which will step through my source code and let me choose some methods to prepend with javadoc-style comments, and then write out a little skeleton comment, perhaps just with "write description here" placeholders for the method and any applicable @param and @return attributes.

Does this exist or am I going to have to write it myself/do it all by hand?

Thanks,
benjamin
 
Srinivas Kalvala
Ranch Hand
Posts: 257
Firefox Browser Hibernate Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Srinivas Kalvala:
Hello,

Development with IDE's like ECLIPSE, WSAD or RAD will make the life very easier. These tools got settings to generate the javadoc automatically and one can configure.

you can download eclipse from,

ECLIPSE DOWNLOAD
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic