logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Affiliation

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

Author

       Chris Dolan <cdolan@cpan.org>

Configuration

       This Policy is not configurable except for the standard options.

Description

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

Name

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

Notes

       Some folks like to use "=for", and "=begin", and "=end" tags to create block comments in-line with their
       code.  Since those tags aren't usually part of the documentation, this Policy does allows them to appear
       before the "__END__" statement.

           =begin comments

           frobulate()
           Accepts:  A list of things to frobulate
           Returns:  True if successful

           =end comments

           sub frobulate { ... }

See Also