Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical
 
PerlMonks  

Re: (tye)Re: Inline POD vs. EOF POD

by John M. Dlugosz (Monsignor)
on Jul 10, 2001 at 00:49 UTC ( #95156=note: print w/ replies, xml ) Need Help??


in reply to (tye)Re: Inline POD vs. EOF POD
in thread Inline POD vs. EOF POD

Tye, you could declare your subs at the top mixed in with the POD. But I don't see what that would buy you, over just having the POD there.

You echo my feelings: inline POD means that the documentation follows the code's organization. Documentation needs its own organization for different purposes: tutorial, group explainations of related functions, etc. Inline documentation would also require some kind of "literate programming" process as well.

—John


Comment on Re: (tye)Re: Inline POD vs. EOF POD
Re: Re: (tye)Re: Inline POD vs. EOF POD
by lachoy (Parson) on Jul 10, 2001 at 01:01 UTC

    I'm intruiged by the potential literate programming aspect of POD (more info, see this excellent node) and, more generally, about being able to machine-generate metadata from documentation, as clemburg pointed out.

    I prefer to keep information as close as possible to where I might generate it and where I might need it again -- the To Do list is the canonical example. I want to add items to my list wherever I'm programming (at the head of a subroutine, for instance) and then periodically generate all my to do items from all my code.

    A natural extension of this is to keep the docs as close to the code as possible, but as has been pointed out in a number of objections here, there are real problems with this. The foremost is probably readability followed closely by, as you mention, organization.

    I'm still not terribly comfortable with putting everything at the end, but I think that's what I'll probably stick with. Until something better comes along :-)

    Chris
    M-x auto-bs-mode

      Hmm, reading the overview in that node, it seems that tangle can be implemented as a source filter, so that the LP file itself is directly shipped.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others cooling their heels in the Monastery: (6)
As of 2014-09-19 07:03 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    How do you remember the number of days in each month?











    Results (132 votes), past polls