comments : Java Glossary

*0-9ABCDEFGHIJKLMNOPQRSTUVWXYZ (all)

comments
There are three types of comment in Java, /**… */, /*… */ and //… end-of-line. If you write a piece of code with a /** Javadoc comment, the convention is the comment belongs to the method or declaration following. When you use a // comment on a line containing code, the comment applies to the code to the left.

However, I am not aware of any universally accepted conventions for: /* and // comments on lines by themselves. Do they belong to the line following or preceding? To be consistent, I suggest the following convention: /* belong to the line following, // belong to the line preceding.

It may be advisable to include a blank line prior to a /* comment (and no blank line after that would separate it from the code it describes), or after a run of // comments (and no blank line prior that would separate it from the code it describes) to further clarify your meaning.

I further suggest using /* comments for big-picture forest level overviews and // comments for line-by-line tree level details.

File Header Comments


This page is posted
on the web at:

http://mindprod.com/jgloss/comments.html

Optional Replicator mirror
of mindprod.com
on local hard disk J:

J:\mindprod\jgloss\comments.html
Canadian Mind Products
Please the feedback from other visitors, or your own feedback about the site.
Contact Roedy. Please feel free to link to this page without explicit permission.

IP:[65.110.21.43]
Your face IP:[54.156.93.60]
You are visitor number