|
|
Back to UserFriendly Strip Comments Index
|
I might actually put a bumper-sticker on my car: | by RetiQlum2 | 2007-05-09 06:24:38 |
| not fond of that, myself |
by tyebald |
2007-05-09 08:35:52 |
I think real programmers should document. I'm not saying we should dedicate our lives to prose, but obfuscatory practices of any kind are counter-productive and inefficient, two things a real programmer should be working to avoid.
That said, the documentation shouldn't need to cater to the lowest common denominator. Writing comments in code that would be sufficiently dumbed down so as to allow Managerial Types(tm) to be able to understand what is going on is an impossible task. But program notes that another competent programmer (like, say, yourself in six months, when the algorithms are no longer hot on the brain) could grasp are cake to produce.
For what it's worth, I initial and date certain comments, when I know they are likely to lose their validity over time. Makes it easier to decide if the comment's content still applies.
And I would love to have a programming environment where comments could actually be explicitly linked to specific statements or groups of statements, such that the comments would automatically get invalidated, or deleted, if the associated code was modified or removed. That, to me, would be a great improvement over existing coding practices. |
|
[ Reply ] |
|
|
[Todays Cartoon Discussion]
[News Index]
|
|