#####################################################
#       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]

In reply to Re: Documenting Methods/Subs by Ctrl-z
in thread Documenting Methods/Subs by vek

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.