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::subroutines::prohibitexcesscomplexity(3) [centos man page]

Perl::Critic::Policy::Subroutines::ProhibitExcessComplexUser3Contributed Perl DocumePerl::Critic::Policy::Subroutines::ProhibitExcessComplexity(3)

NAME

       Perl::Critic::Policy::Subroutines::ProhibitExcessComplexity - Minimize complexity by factoring code into smaller subroutines.

AFFILIATION

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

DESCRIPTION

       All else being equal, complicated code is more error-prone and more expensive to maintain than simpler code.  The first step towards
       managing complexity is to establish formal complexity metrics.  One such metric is the McCabe score, which describes the number of possible
       paths through a subroutine.  This Policy approximates the McCabe score by summing the number of conditional statements and operators within
       a subroutine.  Research has shown that a McCabe score higher than 20 is a sign of high-risk, potentially untestable code.  See
       <http://en.wikipedia.org/wiki/Cyclomatic_complexity> for some discussion about the McCabe number and other complexity metrics.

       The usual prescription for reducing complexity is to refactor code into smaller subroutines.  Mark Dominus book "Higher Order Perl" also
       describes callbacks, recursion, memoization, iterators, and other techniques that help create simple and extensible Perl code.

CONFIGURATION

       The maximum acceptable McCabe can be set with the "max_mccabe" configuration item.  Any subroutine with a McCabe score higher than this
       number will generate a policy violation.  The default is 20.  An example section for a .perlcriticrc:

	 [Subroutines::ProhibitExcessComplexity]
	 max_mccabe = 30

NOTES

	 "Everything should be made as simple as possible, but no simpler."

							 -- Albert Einstein

       Complexity is subjective, but formal complexity metrics are still incredibly valuable.  Every problem has an inherent level of complexity,
       so it is not necessarily optimal to minimize the McCabe number.	So don't get offended if your code triggers this Policy.  Just consider if
       there might be a simpler way to get the job done.

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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::Subroutines::ProhibitExcessComplexity(3)

Check Out this Related Man Page

Perl::Critic::Policy::TestingAndDebugging::RequireUseStrUser3Contributed Perl DocumePerl::Critic::Policy::TestingAndDebugging::RequireUseStrict(3)

NAME

       Perl::Critic::Policy::TestingAndDebugging::RequireUseStrict - Always "use strict".

AFFILIATION

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

DESCRIPTION

       Using strictures is probably the single most effective way to improve the quality of your code.	This policy requires that the 'use strict'
       statement must come before any other statements except "package", "require", and other "use" statements.  Thus, all the code in the entire
       package will be affected.

       There are special exemptions for Moose, Moose::Role, and Moose::Util::TypeConstraints because they enforces strictness; e.g.  'use Moose'
       is treated as equivalent to 'use strict'.

       The maximum number of violations per document for this policy defaults to 1.

CONFIGURATION

       If you take make use of things like Moose::Exporter, you can create your own modules that import the strict pragma into the code that is
       "use"ing them.  There is an option to add to the default set of pragmata and modules in your .perlcriticrc: "equivalent_modules".

	   [TestingAndDebugging::RequireUseStrict]
	   equivalent_modules = MooseX::My::Sugar

SEE ALSO

       Perl::Critic::Policy::TestingAndDebugging::ProhibitNoStrict

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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::TestingAndDebugging::RequireUseStrict(3)
Man Page