Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

Re: Re: Inline POD vs. EOF POD

by lachoy (Parson)
on Jul 09, 2001 at 19:28 UTC ( #95007=note: print w/ replies, xml ) Need Help??


in reply to Re: Inline POD vs. EOF POD
in thread Inline POD vs. EOF POD

Of course I'm commenting subs! :-)

One note: There is, sometimes, a need to comment subroutines using '#' and not in POD. For instance, if you want to write notes to yourself or other coders (as opposed to users) about extremely specific TO DO items or whatnot, '#' comments can be more appropriate. OTOH, you can do something like:

=begin todo Please change the variable names to something less cryptic. Anyone? =end todo

I've been meaning to play around with the nifty-looking Pod::POM module which would make data gathering easy for stuff like this -- for instance, finding out all the TODO items for multiple projects at once.

Chris
M-x auto-bs-mode


Comment on Re: Re: Inline POD vs. EOF POD
Download Code
Re: Re: Re: Inline POD vs. EOF POD
by jplindstrom (Monsignor) on Jul 09, 2001 at 19:37 UTC
    One note: There is, sometimes, a need to comment subroutines using '#' and not in POD. For instance, if you want to write notes to yourself or other coders (as opposed to users) about extremely specific TO DO items or whatnot, '#' comments can be more appropriate.

    Very true. My personal guideline is this:

    • Interface - POD
    • Implemenatation - Perl comment
    /J

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (8)
As of 2014-09-01 21:47 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite cookbook is:










    Results (17 votes), past polls