FAQ 7.27 How can I comment out a large block of perl code?

This is an excerpt from the latest version perlfaq7.pod, which
comes with the standard Perl distribution. These postings aim to
reduce the number of repeated questions as well as allow the community
to review and update the answers. The latest version of the complete
perlfaq is at http://faq.perl.org .

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

7.27: 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.



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

The perlfaq-workers, a group of volunteers, maintain the perlfaq. They
are not necessarily experts in every domain where Perl might show up,
so please include as much information as possible and relevant in any
corrections. The perlfaq-workers also don't have access to every
operating system or platform, so please include relevant details for
corrections to examples that do not work on particular platforms.
Working code is greatly appreciated.

If you'd like to help maintain the perlfaq, see the details in
perlfaq.pod.