Re: Block comments with POD commands

According to perlpod(1), =for uses the next paragraph (everything until a blank line), while =begin runs until a matching =end. If the block of code you're commenting out is just one POD paragraph, it will probably work the same both ways, since =for will ignore the extra =end.

It's important to keep in mind that POD is designed for documentation, not for commenting out blocks of code; the commenting effect is just a convenient side-effect. That's why the syntax seems like a strange way to do comments.

Comment on Re: Block comments with POD commands Select or Download Code

Replies are listed 'Best First'.
Re: Re: Block comments with POD commands by Theo (Priest) on Jul 16, 2003 at 20:32 UTC
Thank you sgifford. Is there a better way to disable a block of code? -ted-	[reply]
Re: Re: Re: Block comments with POD commands by sgifford (Prior) on Jul 16, 2003 at 21:05 UTC
If the code compiles, I often just wrap it in `if (0) { ... }`. If it doesn't and you're commenting it out temporarily, using the POD style is your best bet; just keep in mind that it will feel a little awkward. If it's commented out longer-term, I would put `#` at the beginning of all the lines, as it's less likely to confuse people (including you!) looking at the code later. Hopefully your editor makes `#`-ing out a bunch of lines pretty painless; if not I might consider using POD format anyways. That's just my personal style; I'm sure there are other ways of doing things with their own advantages and disadvantages.	[reply] [d/l] [select]
Re: Re: Re: Block comments with POD commands by cmilfo (Hermit) on Jul 16, 2003 at 20:37 UTC
If it's to be a permanent comment, I stick with using #. If I'm just commenting out code temporarily, I use =cut. `=cut my $code = "I wish to comment"; =cut` [download]	[reply] [d/l]