http://www.perlmonks.org?node_id=95007


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

[download]

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

Replies are listed 'Best First'.
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
[reply]

In Section Meditations