#####################################################
#       RE: documenting methods/subs                #
#       version 0.01                                #
#       This note can be distributed under the same #
#       terms as perl itself                        #
#####################################################

# paragraph 1
# This is my opening statement where i state my 
# opinion on the afore mentioned node.

personally i go for more of a 'tabbed comments to the 
right hand side of an ambiguous statement' Camel-type 
documentation.

# paragraph 2
# some expansion on already stated opinions, and a
# little funny for some light relief

As you say, self-documenting is best - ideally there should 
only be a need to briefly "comment" or refer to other parts 
of the code. Otherwise, you probably dont know have a clear 
concept of the what and why of what you are doing - in which 
case, might as well keep schtum!

# paragraph 3
# my conclusion as to why code written in this format 
# completely sucks and makes no contribution to coding 
# productivity or ledgability

IMHO, using TAB/space to line up common features, liberal use 
of newlines, and well named subs/variables is usually more than 
sufficient to make code readable.

1; # PS i really hate it when people comment on 1;
[download]