Win a copy of Design for the Mind this week in the Design forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Standard way of Commenting codes

 
Mohammed Yousuff
Ranch Hand
Posts: 198
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I like to know what the best ways to comment in a Source code, so that i will be understandable by javadocs and the developer who is going throw that code.

Please provide me some of tips to make the comments properly
 
Jelle Klap
Bartender
Posts: 1951
7
Eclipse IDE Java
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The guidelines for writing comments in code outlined by the Sun code conventions would be a good starting point.
Also, Sun's documentation on writing doc comments that can be processed by the Javadoc tool might be useful.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic