Stories
Slash Boxes
Comments

NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

use Perl

All the Perl that's Practical to Extract and Report

using POD or something else? More | Login | Reply

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.

Without JavaScript enabled, you might want to use the classic discussion system instead. If you login, you can remember this preference.

Two different purposes (Score:1)

by LTjake (4001)

pod and "#" comments serve two distinct purposes.

pod is for API documentation, usage examples, links (see also, websites, etc).

regular "#" comments are there to let the programmer know what is going on in a particular part of the code (see this perlbuzz post for examples: http://perlbuzz.com/mechanix/2007/12/how-to-document-your-code.html [perlbuzz.com])

HTH.
- Re: (Score:1)
  
  by Aristotle (5147)
  
  What he said.
  
  In short, POD is for the guy who uses the code, whereas comments are for the guy who maintains it.
  - Re:Two different purposes (Score:1)
    
    by sigzero (5768) on 2008.01.21 21:37 (#60422) Journal
    
    ding ding ding
    
    I get it now
    
    Reply to This
    
    Parent

Get More Comments

Stories, comments, journals, and other submissions on use Perl; are Copyright 1998-2006, their respective owners.