cvs commit: perlfaq perlfaq7.pod
[email protected] (Robert Spier) 25 Sep 2003 17:44:58 -0000
| Newsgroups | perl.cvs.perlfaq |
|---|---|
| Message-ID | <[email protected]> |
cvsuser 03/09/25 10:44:58
Modified: . perlfaq7.pod
Log:
Change 21349 by rgs@rgs-home on 2003/09/23 22:09:57
The FAQ answer about POD comments was incorrect. [perl #23893]
(plus a few typos.)
Revision Changes Path
1.16 +8 -13 perlfaq/perlfaq7.pod
Index: perlfaq7.pod
===================================================================
RCS file: /cvs/public/perlfaq/perlfaq7.pod,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -w -r1.15 -r1.16
--- perlfaq7.pod 24 Jul 2003 02:17:21 -0000 1.15
+++ perlfaq7.pod 25 Sep 2003 17:44:58 -0000 1.16
@@ -1,6 +1,6 @@
=head1 NAME
-perlfaq7 - General Perl Language Issues ($Revision: 1.15 $, $Date: 2003/07/24 02:17:21 $)
+perlfaq7 - General Perl Language Issues ($Revision: 1.16 $, $Date: 2003/09/25 17:44:58 $)
=head1 DESCRIPTION
@@ -725,32 +725,27 @@
=head2 How can I comment out a large block of perl code?
-You can use embedded POD to discard it. The =for directive
-lasts until the next paragraph (two consecutive newlines).
+You can use embedded POD to discard it. Enclose the blocks you want
+to comment out in POD markers, for example C<=for nobody> and C<=cut>
+(which marks ends of POD blocks).
# program is here
=for nobody
- This paragraph is commented out
-
- # program continues
-
-The =begin and =end directives can contain multiple
-paragraphs.
-
- =begin comment text
all of this stuff
here will be ignored
by everyone
- =end comment text
+ =cut
+
+ # program continues
The pod directives cannot go just anywhere. You must put a
pod directive where the parser is expecting a new statement,
not just in the middle of an expression or some other
-arbitrary s grammar production.
+arbitrary grammar production.
See L<perlpod> for more details.