Beefy Boxes and Bandwidth Generously Provided by pair Networks
Welcome to the Monastery

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

POD SHOULD not be interleaved with the code, and is not an alternative for comments.

Does this include POD put before subroutines? Such as:

=item foo foo $arg1 Does foo =cut sub foo { ... } =item bar bar $foo Does bar =cut sub bar { ... }

Variables with a small scope SHOULD have short names, variables with a broad scope SHOULD have descriptive names.

Heh, there was a guy in my high school C++ class who declared all his counter variables as globals, and he used a different var for every loop. The entire bloody alphabet was at the top of every code file he wrote.

Constants (or variables intended to be constant) . . .

Is there any execuse for not doing "use constant ..."?

No cuddled elses or elsifs . . .


Indents SHOULD be 4 spaces wide. Indents MUST NOT contain tabs.

Where's my flame thrower? :)

In reply to Re: My coding guidelines by hardburn
in thread My coding guidelines by Abigail-II

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, 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, 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.
  • Log In?

    What's my password?
    Create A New User
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others musing on the Monastery: (6)
    As of 2021-04-18 12:38 GMT
    Find Nodes?
      Voting Booth?

      No recent polls found