<?xml version="1.0" encoding="windows-1252"?>
<node id="67783" title="Ways of commenting subroutines" created="2001-03-28 08:35:20" updated="2005-08-07 16:31:44">
<type id="115">
perlquestion</type>
<author id="2329">
stephen</author>
<data>
<field name="doctext">
&lt;P&gt;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...
&lt;P&gt;When I create a module, before each private subroutine I put a comment like so:
&lt;CODE&gt;
##
## user_address()
##
## Arguments:
##    $name: string  Name of the user
##    $phone: string Phone num of user
##
## Returns: string  Address of user
##
## Does a database check on the given user and returns
## the address.
##
sub user_address {
  #whatever
}
&lt;/CODE&gt;
&lt;P&gt;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.

&lt;P&gt;Also, whenever I have a subroutine that will be called from outside the module, I use POD, like so:

&lt;CODE&gt;
=item population()
 
 Arguments:
    $country: string  Country code of country

 Returns: integer  Population of country

Given a country, returns the population.
=cut
sub population { ...
&lt;/CODE&gt;

&lt;P&gt;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?

&lt;P&gt;
stephen
&lt;/P&gt;</field>
</data>
</node>
