| ... |
... |
@@ -23,10 +23,10 @@ |
| 23 |
23 |
* Prescriptive comments |
| 24 |
24 |
* Diary comments |
| 25 |
25 |
* Chatter |
|
26 |
+* Do not use a comment if it can be replaced by a descriptive function or variable. |
| 26 |
26 |
* Position identifier |
| 27 |
|
-* Comments after closing parentheses to emphasize sections that may be useful for long functions. They should be avoided and the function shortened. |
| 28 |
|
-* Attributions |
| 29 |
|
-* Asides |
|
28 |
+* Comments after closing parentheses to emphasize sections may make sense for long functions. They should be avoided and the function abbreviated. |
|
29 |
+* Attributions and asides are unnecessary because source control systems take over this job. |
| 30 |
30 |
* Commented code |
| 31 |
31 |
* HTML comments |
| 32 |
32 |
* Non-local information |
