Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

comment on

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

I agree.

My rules for commenting (from On Coding Standards and Code Reviews) are:

  • Correctness, simplicity and clarity come first. Avoid unnecessary cleverness.
  • If you must rely on cleverness, encapsulate and comment it.
  • Prefer to make the code obvious.
  • Don't belabour the obvious.
  • Generally, comments should describe what and why, not how.
  • Remove commented-out code, unless it helps to understand the code, then clearly mark it as such.
  • Update comments when you change code.
  • Separate user versus maintainer documentation.
  • Include a comment block on every non-trivial method describing its purpose.
  • Major components should have a larger comment block describing their purpose, rationale, etc.
  • There should be a comment on any code that is likely to look wrong or confusing to the next person reading the code.
  • Every non-local named entity (function, variable, class, macro, struct, ...) should be commented.
  • Don't optimize prematurely. Benchmark before you optimize. Comment why you are optimizing.
  • Limit and explicitly comment case "fall throughs".

See also Perl Best Practices, Chapter 7, Documentation, which has some excellent advice on how to document your programs.


In reply to Re: On comments by eyepopslikeamosquito
in thread On comments by pemungkah

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, 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?
    Username:
    Password:

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

    How do I use this? | Other CB clients
    Other Users?
    Others romping around the Monastery: (4)
    As of 2020-02-22 07:27 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      What numbers are you going to focus on primarily in 2020?










      Results (98 votes). Check out past polls.

      Notices?