For Programmers: Free Programming Magazines  


Home > Archive > PERL Miscellaneous > June 2005 > FAQ 7.26 How can I comment out a large block of perl code?









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author FAQ 7.26 How can I comment out a large block of perl code?
PerlFAQ Server

2005-06-09, 3:57 am

This message is one of several periodic postings to comp.lang.perl.misc
intended to make it easier for perl programmers to find answers to
common questions. The core of this message represents an excerpt
from the documentation provided with Perl.

--------------------------------------------------------------------

7.26: How can I comment out a large block of perl code?

You can use embedded POD to discard it. Enclose the blocks you want to
comment out in POD markers. The <=begin> directive marks a section for a
specific formatter. Use the "comment" format, which no formatter should
claim to understand (by policy). Mark the end of the block with <=end>.

# program is here

=begin comment

all of this stuff

here will be ignored
by everyone

=end comment

=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 grammar production.

See perlpod for more details.



--------------------------------------------------------------------

Documents such as this have been called "Answers to Frequently
Asked Questions" or FAQ for short. They represent an important
part of the Usenet tradition. They serve to reduce the volume of
redundant traffic on a news group by providing quality answers to
questions that keep coming up.

If you are some how irritated by seeing these postings you are free
to ignore them or add the sender to your killfile. If you find
errors or other problems with these postings please send corrections
or comments to the posting email address or to the maintainers as
directed in the perlfaq manual page.

Note that the FAQ text posted by this server may have been modified
from that distributed in the stable Perl release. It may have been
edited to reflect the additions, changes and corrections provided
by respondents, reviewers, and critics to previous postings of
these FAQ. Complete text of these FAQ are available on request.

The perlfaq manual page contains the following copyright notice.

AUTHOR AND COPYRIGHT

Copyright (c) 1997-2002 Tom Christiansen and Nathan
Torkington, and other contributors as noted. All rights
reserved.

This posting is provided in the hope that it will be useful but
does not represent a commitment or contract of any kind on the part
of the contributers, authors or their agents.
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2009 codecomments.com