Do you know where your variables are? | |
PerlMonks |
Re: Inline POD vs. EOF PODby DrSax (Sexton) |
on Jul 09, 2001 at 22:19 UTC ( [id://95083]=note: print w/replies, xml ) | Need Help?? |
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
In Section
Meditations
|
|