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??

The source being available is no reason not to write documentation. If everyone had to read the glibc and Linux kernel sources to write programs for Linux, we'd never have gotten anywhere.

Documentation is like sex — when it's good, it's very good, and when it's bad, it's still better than nothing.

The fact that POD makes it particularly easy to document means you really have no excuse not to write documentation. Imagine CPAN without POD, and half the modules without documentation: sure, there's all this great code out there, but if you want to know what it does you have to download and unpack it, and if there's no docs, read the source. How much use would such a repository be?

One thing that's cool about the hacker culture, however, is that even if you only wrote very sparse docs to begin with, if there's a lot of interest in your code it's likely that others will contribute documentation. They can also spot documentation errors for you, because they can read the source. Just remember that without any docs, it's not likely that anyone else will get interested. Make it habit to slap at least some basic POD onto your Perl code.

Makeshifts last the longest.


In reply to Re^2: OOPerl isn't that bad after all... (do write docs) by Aristotle
in thread OOPerl isn't that bad after all... by yosefm

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 contemplating the Monastery: (8)
As of 2024-04-23 16:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found