Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

Re: flower box comments

by PodMaster (Abbot)
on Nov 17, 2003 at 06:33 UTC ( #307576=note: print w/replies, xml ) Need Help??


in reply to flower box comments

You're not missing anything, your group is misguided.
=head2 get_records my @foo = get_records( $dbh , "select * from BAR..." ); =cut sub get_records { # ... }
Now you run it through perldoc, pod2man, pod2text, pod2html ...

Comments are not documentation ;)

*links here*

MJD says "you can't just make shit up and expect the computer to know what you mean, retardo!"
I run a Win32 PPM repository for perl 5.6.x and 5.8.x -- I take requests (README).
** The third rule of perl club is a statement of fact: pod is sexy.

Replies are listed 'Best First'.
Re: Re: flower box comments
by cleverett (Friar) on Nov 17, 2003 at 08:12 UTC
    I avoid documenting private subroutines with POD.

    POD implies public.

      POD only implies pod and sexy.
      =for private =head2 get_records my @foo = get_records( $dbh , "select * from BAR..." ); =cut =begin private =head2 get_records my @foo = get_records( $dbh , "select * from BAR..." ); =end private =cut

      MJD says "you can't just make shit up and expect the computer to know what you mean, retardo!"
      I run a Win32 PPM repository for perl 5.6.x and 5.8.x -- I take requests (README).
      ** The third rule of perl club is a statement of fact: pod is sexy.

        PodMaster sez:

        POD only implies pod and sexy.

        =for private =head2 get_records my @foo = get_records( $dbh , "select * from BAR..." ); =cut =begin private =head2 get_records my @foo = get_records( $dbh , "select * from BAR..." ); =end private =cut

        It's OK PodMaster, I understand: somebody has to carry the B & D torch ...

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others browsing the Monastery: (8)
As of 2019-09-18 03:09 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    The room is dark, and your next move is ...












    Results (220 votes). Check out past polls.

    Notices?