Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl-Sensitive Sunglasses
 
PerlMonks  

Re: Inline POD vs. EOF POD

by DrSax (Sexton)
on Jul 09, 2001 at 22:19 UTC ( #95083=note: print w/ replies, xml ) Need Help??


in reply to Inline POD vs. EOF POD

I understand the reasons behind inline POD, but I would have to fall into the camp of those who prefer EOF POD. This is especially true for package development. Here is my reasoning:

I tend of think of the usefulness of POD being for the people who are going to use my package. I don't want to have to spend time explaining to my other developers how to use my class; that's why I documented it in POD so they can do perldoc MyClass. When I write the POD I do it as if I were writing documentation. Having everything in one place (at the end) makes it easier for me to see how it will look afterward.

I think this applies very much in the case of the person who is going to use your module, and less in the case of a person who is going to modify it. So the final tally is:
EOF POD is for class re-use.
inline POD is better for cooperative development.

Brian - a.k.a. DrSax


Comment on Re: Inline POD vs. EOF POD
Download Code

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others chanting in the Monastery: (10)
As of 2014-12-28 15:32 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (182 votes), past polls