Your suggestions make a lot of sense. Documentation is a very good thing that I'm not very good at. I will have to get to grips with POD but it's something I have been putting off.</blocckquote>I know this is mere proselytism, anyway in case you don't really get into POD you could give ROBODoc a try. It has a couple of advantages:
- It sucks up much less space than POD;
- It mixes up fine with code and comments (you can easily make documentation from your comments);
- It works with any language I know of, so you can ROBODoc your Java, your html, your C and your PHP too.
- ROBODoc can build a one-document digest from a whole code tree;
- You can anyway generate HTML, RTF, PDF... from ROBODoc as well as POD;
- Last, you can also generate POD with the ROBODoc to Pod translator script.
In reply to Re^3: Create and edit new scripts by wazoox
in thread Create and edit new scripts by johngg
- 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, details, 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, summary, 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: & & < < > > [ [ ] ] - Link using PerlMonks shortcuts! What shortcuts can I use for linking?
- See Writeup Formatting Tips and other pages linked from there for more info.