| ... | ... | @@ -3,12 +3,11 @@ |
|
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
[:arrow_left: Introduction](smells-and-heuristics-introduction) | [Comments :arrow_right: ](smells-and-heuristics-comments)
|
|
|
|
[:arrow_left: Comments](smells-and-heuristics-comments) | [Environment :arrow_right: ](smells-and-heuristics-environment)
|
|
|
|
|
|
|
|
# Comments
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
__C1: Inappropriate Information__
|
|
|
|
|
|
|
|
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.
|
| ... | ... | @@ -22,4 +21,4 @@ A comment that has gotten old, irrelevant, and incorrect is obsolete. Comments g |
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
[:arrow_left: Introduction](smells-and-heuristics-introduction) | [Comments :arrow_right: ](smells-and-heuristics-comments) |
|
|
\ No newline at end of file |
|
|
|
[:arrow_left: Comments](smells-and-heuristics-comments) | [Environment :arrow_right: ](smells-and-heuristics-environment) |
|
|
\ No newline at end of file |
