perl::critic::policy::subroutines::requirefinalreturn(3) [centos man page]

Perl::Critic::Policy::Subroutines::RequireFinalReturn(3)User Contributed Perl DocumentatioPerl::Critic::Policy::Subroutines::RequireFinalReturn(3)

NAME

       Perl::Critic::Policy::Subroutines::RequireFinalReturn - End every path through a subroutine with an explicit "return" statement.

AFFILIATION

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

DESCRIPTION

       Require all subroutines to terminate explicitly with one of the following: "return", "carp", "croak", "die", "exec", "exit", "goto", or
       "throw".

       Subroutines without explicit return statements at their ends can be confusing.  It can be challenging to deduce what the return value will
       be.

       Furthermore, if the programmer did not mean for there to be a significant return value, and omits a return statement, some of the
       subroutine's inner data can leak to the outside.  Consider this case:

	   package Password;
	   # every time the user guesses the password wrong, its value
	   # is rotated by one character
	   my $password;
	   sub set_password {
	       $password = shift;
	   }
	   sub check_password {
	       my $guess = shift;
	       if ($guess eq $password) {
		   unlock_secrets();
	       } else {
		   $password = (substr $password, 1).(substr $password, 0, 1);
	       }
	   }
	   1;

       In this case, the last statement in check_password() is the assignment.	The result of that assignment is the implicit return value, so a
       wrong guess returns the right password!	Adding a "return;" at the end of that subroutine solves the problem.

       The only exception allowed is an empty subroutine.

       Be careful when fixing problems identified by this Policy; don't blindly put a "return;" statement at the end of every subroutine.

CONFIGURATION

       If you've created your own terminal functions that behave like "die" or "exit", then you can configure Perl::Critic to recognize those
       functions as well.  Just put something like this in your .perlcriticrc:

	   [Subroutines::RequireFinalReturn]
	   terminal_funcs = quit abort bailout

BUGS

       We do not look for returns inside ternary operators.  That construction is too complicated to analyze right now.  Besides, a better form is
       the return outside of the ternary like this: "return foo ? 1 : bar ? 2 : 3"

AUTHOR

       Chris Dolan <cdolan@cpan.org>

COPYRIGHT

       Copyright (c) 2005-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::Subroutines::RequireFinalReturn(3)

Check Out this Related Man Page

Perl::Critic::Policy::Subroutines::ProhibitReturnSort(3pUser Contributed Perl DocumentatPerl::Critic::Policy::Subroutines::ProhibitReturnSort(3pm)

NAME

       Perl::Critic::Policy::Subroutines::ProhibitReturnSort - Behavior of "sort" is not defined if called in scalar context.

AFFILIATION

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

DESCRIPTION

       The behavior of the builtin "sort" function is not defined if called in scalar context.	So if you write a subroutine that directly
       "return"s the result of a "sort" operation, then you code will behave unpredictably if someone calls your subroutine in a scalar context.
       This Policy emits a violation if the "return" keyword is directly followed by the "sort" function.  To safely return a sorted list of
       values from a subroutine, you should assign the sorted values to a temporary variable first.  For example:

	  sub frobulate {

	      return sort @list;  # not ok!

	      @sorted_list = sort @list;
	      return @sort	  # ok
	  }

KNOWN BUGS

       This Policy is not sensitive to the "wantarray" function.  So the following code would generate a false violation:

	  sub frobulate {

	      if (wantarray) {
		  return sort @list;
	      }
	      else{
		  return join @list;
	      }
	  }

CONFIGURATION

       This Policy is not configurable except for the standard options.

CREDITS

       This Policy was suggested by Ulrich Wisser and the <http://iis.se> team.

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.14.2							    2012-06-07		Perl::Critic::Policy::Subroutines::ProhibitReturnSort(3pm)

Linux and UNIX Man Pages

perl::critic::policy::subroutines::requirefinalreturn(3) [centos man page]

Check Out this Related Man Page