summaryrefslogtreecommitdiff
path: root/pod/perlfaq7.pod
diff options
context:
space:
mode:
authorRafael Garcia-Suarez <rgarciasuarez@gmail.com>2003-09-23 22:09:57 +0000
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2003-09-23 22:09:57 +0000
commit659cfd94ba23a1b903a75ecaffde534106f93c22 (patch)
tree17ebfc94dff6effbb1937078bf35d5c9d1e7d202 /pod/perlfaq7.pod
parentf83912f27d5903d07e19b71d691d929ef9066cbc (diff)
downloadperl-659cfd94ba23a1b903a75ecaffde534106f93c22.tar.gz
The FAQ answer about POD comments was incorrect. [perl #23893]
(plus a few typos.) p4raw-id: //depot/perl@21349
Diffstat (limited to 'pod/perlfaq7.pod')
-rw-r--r--pod/perlfaq7.pod19
1 files changed, 7 insertions, 12 deletions
diff --git a/pod/perlfaq7.pod b/pod/perlfaq7.pod
index a735edc7c8..96d6b88d4a 100644
--- a/pod/perlfaq7.pod
+++ b/pod/perlfaq7.pod
@@ -725,32 +725,27 @@ not necessarily the same as the one in which you were compiled):
=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.