| ... | ... | @@ -13,12 +13,12 @@ |
|
|
|
It is inappropriate for a comment to hold information better held in a different kind of system such as your source code control system, your issue tracking system, or any other record-keeping system. Change histories, for example, just clutter up source files with volumes of historical and uninteresting text. In general, meta-data such as authors, last- modified-date, SPR number, and so on should not appear in comments. Comments should be reserved for technical notes about the code and design.
|
|
|
|
|
|
|
|
|
|
|
|
__C2: Obsolete Comment__
|
|
|
|
#### C2: Obsolete Comment
|
|
|
|
|
|
|
|
A comment that has gotten old, irrelevant, and incorrect is obsolete. Comments get old quickly. 1t is bestnot to write a comment that will become obsolete. If you find an obsolete comment, it is best to update it or get rid of it as quickly as possible. Obsolete comments tend to migrate away from the code they once described. They become floating islands of irrelevance and misdirection in the code.
|
|
|
|
|
|
|
|
|
|
|
|
__C3: Redundant Comment__
|
|
|
|
#### C3: Redundant Comment
|
|
|
|
|
|
|
|
A comment is redundant if it describes something that adequately describes itself. For example:
|
|
|
|
|
| ... | ... | |
