Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::documentation::requirepodatend(3pm) [debian man page]

Perl::Critic::Policy::Documentation::RequirePodAtEnd(3pmUser Contributed Perl DocumentatiPerl::Critic::Policy::Documentation::RequirePodAtEnd(3pm)

NAME

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

AFFILIATION

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

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__".

CONFIGURATION

       This Policy is not configurable except for the standard options.

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 { ... }

AUTHOR

       Chris Dolan <cdolan@cpan.org>

COPYRIGHT

       Copyright (c) 2006-2011 Chris Dolan.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  The full text of this license
       can be found in the LICENSE file included with this module

perl v5.14.2							    2012-06-07		 Perl::Critic::Policy::Documentation::RequirePodAtEnd(3pm)

Check Out this Related Man Page

Perl::Critic::Policy::Variables::ProtectPrivateVars(3)	User Contributed Perl Documentation Perl::Critic::Policy::Variables::ProtectPrivateVars(3)

NAME

       Perl::Critic::Policy::Variables::ProtectPrivateVars - Prevent access to private vars in other packages.

AFFILIATION

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

DESCRIPTION

       By convention Perl authors (like authors in many other languages) indicate private methods and variables by inserting a leading underscore
       before the identifier.  This policy catches attempts to access private variables from outside the package itself.

CONFIGURATION

       This Policy is not configurable except for the standard options.

HISTORY

       This policy is inspired by a similar test in B::Lint

SEE ALSO

       Perl::Critic::Policy::Subroutines::ProtectPrivateSubs

AUTHOR

       Chris Dolan <cdolan@cpan.org>

COPYRIGHT

       Copyright (c) 2006-2011 Chris Dolan.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.  The full text of this license
       can be found in the LICENSE file included with this module.

perl v5.16.3							    2014-06-09		    Perl::Critic::Policy::Variables::ProtectPrivateVars(3)
Man Page