Clear questions and runnable code get the best and fastest answer |
|
PerlMonks |
Re: What is your practice for code documentation?by sundialsvc4 (Abbot) |
on Jun 28, 2008 at 02:05 UTC ( [id://694481]=note: print w/replies, xml ) | Need Help?? |
Think about it this way: how well does a telephone directory describe a town? When I am looking at the documentation for a piece of computer software, sometimes I am looking for a directory. I really do just want to know where a particular place or thing is. But... not most of the time. In fact, almost never. No. What I really want is: to read the original developer's thoughts. I want to get a glimpse of her intent when she designed and then wrote that particular piece of code. Truly, the final software is very-much an expression of that, and this is something that no amount of computer-generated recyclables will tell me.
In Section
Meditations
|
|