File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
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
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "Standard way of Commenting codes" Watch "Standard way of Commenting codes" New topic

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 :
Try not to become a man of success but rather to become a man of value.
Jelle Klap

Joined: Mar 10, 2008
Posts: 1951

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.
I agree. Here's the link:
subject: Standard way of Commenting codes
It's not a secret anymore!