Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

( [id://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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others perusing the Monastery: (6)
As of 2024-03-19 08:32 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found