comments : Java Glossary

go to home page C words local find full screen, hide local find menu Google search web for more information on this topic jump to foot of page translate this page with Babelfish punctuation 0-9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z (all) ©1996-2009 2006-03-04 Roedy Green, Canadian Mind Products
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

Embedded Comments

Here are my recommendations for comment style:
Javadoc
CMP homejump to top You can get the freshest copy of this page from: or possibly from your local J: drive (Java virtual drive/mindprod.com website mirror)
http://mindprod.com/jgloss/comments.html J:\mindprod\jgloss\comments.html
CMP logofeedback Please email your feedback for publication, errors, omissions, typos, formatting errors, ambiguities, unclear wording, broken/redirected link reports, suggestions to improve this page or comments to Roedy Green : feedback email
mindprod.com IP:[65.110.21.43]
view BlogYour face IP:[38.107.191.104]
You are visitor number 13,297.