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
7

DESCRIPTION

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

NOTES

17       Some folks like to use "=for", and "=begin", and "=end" tags to create
18       block comments in-line with their code.  Since those tags aren't usu‐
19       ally part of the documentation, this Policy does allows them to appear
20       before the "__END__" statement.
21
22         =begin comments
23
24         frobulate()
25         Accepts:  A list of things to frobulate
26         Returns:  True if succesful
27
28         =end comments
29
30         sub frobulate { ... }
31

AUTHOR

33       Chris Dolan <cdolan@cpan.org>
34

36       Copyright (c) 2006 Chris Dolan.  All rights reserved.
37
38       This program is free software; you can redistribute it and/or modify it
39       under the same terms as Perl itself.  The full text of this license can
40       be found in the LICENSE file included with this module
41
42
43
44perl v5.8.8            Perl::Criti2c0:0:7P-o0l3i-c2y0::Documentation::RequirePodAtEnd(3)
Impressum