comment | can be written before writing the code | ![2001-08-30 14:54:57.0](facet.gif) |
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 | ![2001-08-30 14:54:57.0](facet.gif) |
is essential to give readers an overview and to help them understand its complexities quickly | ![2001-08-30 14:54:57.0](facet.gif) |
is a subtopic of Programming Style Guidelines | ![2001-08-30 14:54:57.0](facet.gif) |
is a kind of programming language construct | ![2001-08-30 14:54:57.0](facet.gif) |
should be between about 20% and 35% of the total length of the code | ![2001-08-30 14:54:57.0](facet.gif) |
should be written to describe each non-obvious variable | ![2001-08-30 14:54:57.0](facet.gif) |
should be written to describe loops and conditional statements inside complex algorithms | ![2001-08-30 14:54:57.0](facet.gif) |
should be written at the head of each non-obvious method describing its function and usage | ![2001-08-30 14:54:57.0](facet.gif) |
should be written at the top of each class | ![2001-08-30 14:54:57.0](facet.gif) |
should describe the purpose of the class, how it should be used, its authors and its history of modification | ![2001-08-30 14:54:57.0](facet.gif) |
should not be about obvious things since they add clutter | ![2001-08-30 14:54:57.0](facet.gif) |