Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

comment on

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

I have read plenty of unfamiliar code that was written by someone whose then-present motivations I simply did not understand, except for the comments that he left behind ... and that person was me.   If you set-aside a program that you wrote, even for a very short time, then you will frankly be amazed at how little you actually remember of what you did and why.   The programmer’s intentions will now be an utter mystery.   Comments and per-sub documentation is therefore quite essential.

I also believe that you should maintain your code in a change-control system and keep an issue-tracker ... even though you imagine that no one other than yourself will ever touch this code and that you will remember everything.   You will not.

“Code review” awareness is also crucial even if you are reviewing yourself.   Would someone who had never encountered this piece of code before, manage to understand it ... accurately and quickly?   Is the logic “stupid simple?”   Yes, this is important, because soon enough that person will come along.   And that person could very well be you.


In reply to Re: documentation best practices for internal modules by sundialsvc4
in thread documentation best practices for internal modules by hotshoe

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 making s'mores by the fire in the courtyard of the Monastery: (4)
    As of 2020-12-05 00:22 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      How often do you use taint mode?





      Results (63 votes). Check out past polls.

      Notices?