|Syntactic Confectionery Delight|
Ways of commenting subroutinesby stephen (Priest)
|on Mar 28, 2001 at 13:35 UTC||Need Help??|
stephen has asked for the
wisdom of the Perl Monks concerning the following question:
I'm interested in what subroutine commenting practices people use. I'm not interested in figuring out which is the "best", just wonder methods others use...
When I create a module, before each private subroutine I put a comment like so:
I always use empty parentheses on the top line, just to make it obvious from a glance that this block of comments documents a subroutine.
Also, whenever I have a subroutine that will be called from outside the module, I use POD, like so:
My question: what do you do? I've seen a few varying styles in CPAN documentation... is there one style that you've found particularily useful, and why?