A friendly place for programming greenhorns!
Big Moose Saloon
Register / Login
Standard way of Commenting codes
Joined: Oct 17, 2007
Sep 24, 2008 05:13:00
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 :
Try not to become a man of success but rather to become a man of value.
Joined: Mar 10, 2008
Sep 24, 2008 05:21:00
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.
It is sorta covered in the
JavaRanch Style Guide
subject: Standard way of Commenting codes
assignments and + operator
Access a variable
for loop question
All times are in JavaRanch time: GMT-6 in summer, GMT-7 in winter
| Powered by
Copyright © 1998-2014