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:
##
## 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
}
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:
=item population()
Arguments:
$country: string Country code of country
Returns: integer Population of country
Given a country, returns the population.
=cut
sub population { ...
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?
stephen
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|