1Perl::Critic::Policy::DUosPceeurrmleC:no:tnCatrtriiitobinuc:t::e:RdPeoqPlueiircrlye:PD:ooDdcoAuctmuEemnnedtn(at3ta)itoinon::RequirePodAtEnd(3)
2
3
4

NAME

6       Perl::Critic::Policy::Documentation::RequirePodAtEnd - All POD should
7       be after "__END__".
8

AFFILIATION

10       This Policy is part of the core Perl::Critic distribution.
11

DESCRIPTION

13       Perl stops processing code when it sees an "__END__" statement.  So, to
14       save processing time, it's faster to put documentation after the
15       "__END__".  Also, writing all the POD in one place usually leads to a
16       more cohesive document, rather than being forced to follow the layout
17       of your code.  This policy issues violations if any POD is found before
18       an "__END__".
19

CONFIGURATION

21       This Policy is not configurable except for the standard options.
22

NOTES

24       Some folks like to use "=for", and "=begin", and "=end" tags to create
25       block comments in-line with their code.  Since those tags aren't
26       usually part of the documentation, this Policy does allows them to
27       appear before the "__END__" statement.
28
29           =begin comments
30
31           frobulate()
32           Accepts:  A list of things to frobulate
33           Returns:  True if successful
34
35           =end comments
36
37           sub frobulate { ... }
38

AUTHOR

40       Chris Dolan <cdolan@cpan.org>
41

43       Copyright (c) 2006-2011 Chris Dolan.
44
45       This program is free software; you can redistribute it and/or modify it
46       under the same terms as Perl itself.  The full text of this license can
47       be found in the LICENSE file included with this module
48
49
50
51perl v5.30.0           Perl::Criti2c0:1:9P-o0l7i-c2y6::Documentation::RequirePodAtEnd(3)
Impressum