Clear questions and runnable code get the best and fastest answer |
|
PerlMonks |
Re: Ways of commenting subroutinesby kal (Hermit) |
on Mar 28, 2001 at 16:07 UTC ( [id://67800]=note: print w/replies, xml ) | Need Help?? |
I like using pre- and post- conditions a lot of the time. The subroutine should say what it expects, and under what conditions you get a return value, etc. Something like:
Okay, Noddy example, I know. It marks out under what conditions the author expected to reach these areas. If there is a bug at all, either it's because there is a precondition that we haven't thought about, or we don't successfully reach the postcondition (i.e., incorrect code). Also, putting in carps and things helps you track better what's going on if you follow the PREs and POSTs. It's one of the things that works for me, anyway :) (obviously, this is in addition to all the other comments and stuff you make!!)
In Section
Seekers of Perl Wisdom
|
|