This week's book giveaway is in the Servlets forum.
We're giving away four copies of Murach's Java Servlets and JSP and have Joel Murach on-line!
See this thread for details.
The moose likes Beginning Java and the fly likes Standard way of Commenting codes Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Murach's Java Servlets and JSP this week in the Servlets forum!
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Standard way of Commenting codes" Watch "Standard way of Commenting codes" New topic
Author

Standard way of Commenting codes

Mohammed Yousuff
Ranch Hand

Joined: Oct 17, 2007
Posts: 198
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


My Thoughts : http://passion4java.blogspot.com
Try not to become a man of success but rather to become a man of value.
Jelle Klap
Bartender

Joined: Mar 10, 2008
Posts: 1753
    
    7

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.


Build a man a fire, and he'll be warm for a day. Set a man on fire, and he'll be warm for the rest of his life.
 
jQuery in Action, 2nd edition
 
subject: Standard way of Commenting codes
 
Similar Threads
for loop question
assignments and + operator
lockCookie
Access a variable
JSP called from filter not finding JavaScript file