Java comment | has example executeMe(); // doNotExecuteMe |  |
has example executeMeToo(); /* This is to be ignored and this too */ |  |
has form '/*' comment '*/' or two slashes '//' indicating that the rest of the line is to be considered a comment |  |
is a subtopic of The Basics of Java |  |
is a kind of comment |  |
comment | can be written before writing the code |  |
has purpose to describe the purpose of each class, method and variable along with any difficult-to-understand statements inside methods, and to indicated any changes to the code |  |
is essential to give readers an overview and to help them understand its complexities quickly |  |
should be between about 20% and 35% of the total length of the code |  |
should be written to describe each non-obvious variable |  |
should be written to describe loops and conditional statements inside complex algorithms |  |
should be written at the head of each non-obvious method describing its function and usage |  |
should be written at the top of each class |  |
should describe the purpose of the class, how it should be used, its authors and its history of modification |  |
should not be about obvious things since they add clutter |  |