Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical

Re: Ways of commenting subroutines

by Masem (Monsignor)
on Mar 28, 2001 at 17:53 UTC ( #67818=note: print w/replies, xml ) Need Help??

in reply to Ways of commenting subroutines

Another possibility beyond those talked about here are using comment-to-documentation formats such as Javadoc or Doxygen, which require to have certain key lines in the comments preceeding a function to describe what happens; the comments are still quite readable within the code, and you've got an easy way to make usable documentation outside of the POD mechanism if your project calls for it.
Dr. Michael K. Neylon - || "You've left the lens cap of your mind on again, Pinky" - The Brain

Replies are listed 'Best First'.
Re: Re: Ways of commenting subroutines
by gumpu (Friar) on Mar 28, 2001 at 19:06 UTC

    Or Robodoc, which should work with perl too.

    Have Fun