I'm using POD for the first time. Unlike POD's counterparts for C# and Java
programming, POD is pretty unstructured.
(1) Are there some favorite examples to follow? For example, I learned from
looking at CGI.pm, but was surprised that there was not set of comments
preceding each function that describes the function. Is this typical?
(2) I started to write a little emacs function to insert my standard POD
skeleton for the beginning of a module and a second emacs function to insert
my standard POD skeleton for every function. The problem is, being new, I
don't' have any standards. Can anyone reference me to some POD skeletons for
functions, modules, global variables and classes?
(3) When perl programmers document their functions, are they encouraged to
use some kind of machine readable notation to indicate if function argument
is passed by reference or by value, if it is input, output or modified,
scalar or array or hash etc...? I have not seen this in the perl code I've
looked at and I am surprised. It seems to me that POD ought to encourage one
to record all the information necessary to call the function. The same goes
for classes: is that data member public, private, protected, internal etc...
Does anyone record these kind of details in the POD fragments? If so, do
you have an example I could follow?
Thanks,
Siegfried
--
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
<http://learn.perl.org/> <http://learn.perl.org/first-response>
