Your skill will accomplish what the force of many cannot |
|
PerlMonks |
Re: Documenting Methods/Subsby dragonchild (Archbishop) |
on Jan 10, 2003 at 16:35 UTC ( [id://225855]=note: print w/replies, xml ) | Need Help?? |
I've noticed that, personally, I only like subs to be commented (and heavily commented at that) if I don't know the code. Once I know the code, I actually hate the comments.
There's one file I'm working on right now that has every single function extensively documented with POD. I hate it, cause it gets in my way of seeing the whole code. But, when I first started working on it, it gave me a smidge of insight into what the author was thinking. (Granted, it's only a smidge cause the author sits about 50 feet from me, but it would've been a heck of a lot more if the author wasn't around to ask questions of.) I guess that if the person after you can ask you questions, don't comment it. If the person after will not be able to ask you questions, comment evey single assumption you make. YMMV. ------ Don't go borrowing trouble. For programmers, this means Worry only about what you need to implement.
In Section
Meditations
|
|