Java Reference
In-Depth Information
//*****************************************
// header block
//*****************************************
D. In-Line Comments
1. Use in-line documentation as appropriate to clearly describe interesting
processing.
2. Put a comment on the same line with code only if the comment applies to
one line of code and can fit conveniently on that line. Otherwise, put the
comment on a separate line above the line or section of code to which it
applies.
E. Miscellaneous
1. Avoid the use of the /* */ style of comment except to conform to the
javadoc ( /** */ ) commenting convention.
2. Don't wait until a program is finished to insert documentation. As pieces of
your system are completed, comment them appropriately.
 
Search WWH ::




Custom Search