Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Comment on

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

    Still, I have to write code to document, and then I'm back to the same old situation.

Try writing the documentation first, then the code. Now, you're allowed to go back and change the documentation if you discover a better way of doing it while coding, but go change the doc as these cases are being discovered.

Then, you won't have the documentation hanging over you at the "end" of a project.

Better yet, stop thinking about projects having an "end". Most programs are changed over time. There are just relatively active periods of development followed by relatively inactive periods of development.

Note that the above is all speculative on my part as I, myself, usually put off documentation until after I'm "done" with coding. This is all just do what I say, not as I do... Better to be a hypocrite who proclaims the truth rather than a silent person who has nothing good to say, I guess. Maybe someday, I'll actually catch myself following my own good advice. :-)


In reply to Re: Re: Re: I can't get no... by jordanh
in thread I can't get no... by jepri

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?
    [Discipulus]: he does not learn, nor teach, nor learn
    [planetscape]: hello all
    [stonecolddevin]: o/ planetscape
    [Sinistral]: I think that just the sight of his username now causes a downvote storm. I agree, and the gratuitous use of formatting does make reading hard. I've given him +1 on things where there seemed to be actual good advice, but I think the big
    [Sinistral]: nail in coffin was the rant against a Schwarzian Transform
    [stonecolddevin]: at best, from what i've seen, his knowledge is accurate up to maybe 2002. the sheer volume of words is mostly worthy of a downvote in most cases though i think
    [erix]: ITYM Schwartzian Transform :P
    [erix]: hey planetscape :)
    [planetscape]: howdy stonecolddevin, erix
    [Sinistral]: eric Aye. I thought I typed that wrong. All hail Randall! I listen to him on FLOSS Weekly

    How do I use this? | Other CB clients
    Other Users?
    Others browsing the Monastery: (10)
    As of 2017-06-22 20:54 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      How many monitors do you use while coding?















      Results (530 votes). Check out past polls.