Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Re: Preferred method of documentation?

by Anonymous Monk
on Oct 11, 2004 at 17:21 UTC ( #398221=note: print w/replies, xml ) Need Help??


in reply to Preferred method of documentation?

Consider POD first (for Perl), then maybe XML/XSLT. Either one will export easily to other formats.

I have a modest Perl/Tk program of some umpteen modules. In all it runs to 3629 lines of code, 1052 comment lines and a longish POD tagging along at the end. It is available on-line here...

http://starling.us/tet/gus_perl/#GUS-1

The in-line comments are for me to know which subs do what. Any snippet of Perl, however small, gets a comment if come next year I might have forgotten what it is for. The POD I usually aim at the user...or as a general overview. For the user I'll also convert the POD into HTML for display online.

Inside the link cited above cited above is a button labled "POD as HTML" which is what it says it is. But the save you the trouble of pressing it, I give same below...

http://starling.us/tet/gus_perl/gus_rpc_edit_pl/gus_rpc_edit.html

Such as it is, that is the method which works for me in writing Perl. For absolutely everything else I default to XML/XSLT. The link cited above was exported to HTML from XML/XSLT. If you like, I have something on XML/XSLT here...

http://starling.ws

Replies are listed 'Best First'.
Re^2: Preferred method of documentation?
by aplonis (Pilgrim) on Oct 11, 2004 at 17:30 UTC
    Oops! I failed to observe that my login failed before replying. So it says "Anonymous Monk" so that blame may fall where do, I confess. It was I. Gan Starling

      Change your theme and it will be easier to realize your not logged in.

      "Cogito cogito ergo cogito sum - I think that I think, therefore I think that I am." Ambrose Bierce

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://398221]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (3)
As of 2020-11-27 00:43 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?