in reply to Re^4: Easily catalog subroutines with a synopsis comment
in thread Easily catalog subroutines with a synopsis comment
The excuse I hear over and over from programmers who don't write POD, don't write tests, and write incomprehensible code that they can include comments and everything will be OK.
Comments should be the item of last resort. For figuring out what code does, writing clear, concise code is first, followed by Pod, then unit tests and as a last resort, comments.
The reason for doing this in this order,
If your code is so abstract that people cannot understand it, you have created a Rube Goldberg Machine that cannot be updated easily and will eventually end up being disgarded by something that can.
The one thing I believe in is documentation, just not half-hearted attempts by calling them 'comments.'
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re^6: Easily catalog subroutines with a synopsis comment
by hsmyers (Canon) on Apr 21, 2008 at 05:14 UTC |