Skip to content

GitLab

smells and heuristics comments · Changes

Page history
mmclin: fixed typo authored by Mike McLin's avatar Mike McLin
Hide whitespace changes
Inline Side-by-side
smells-and-heuristics-comments.markdown
View page @ e93673a3
......@@ -15,7 +15,7 @@ It is inappropriate for a comment to hold information better held in a different
#### 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.
A comment that has gotten old, irrelevant, and incorrect is obsolete. Comments get old quickly. It is best not 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
......