1. Manuals
  2. Tumbleweed
  3. perl-Perl-Critic
  4. Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator(3pm)

Scroll to navigation

Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator(3pm) User Contributed Perl Documentation Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator(3pm)

NAME

Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator - Write " <<'THE_END'; " instead of " <<'theEnd'; ".

AFFILIATION

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

DESCRIPTION

For legibility, HEREDOC terminators should be all UPPER CASE letters (and numbers), without any whitespace. Conway also recommends using a standard prefix like "END_" but this policy doesn't enforce that.

  print <<'the End';  #not ok
  Hello World
  the End
  print <<'THE_END';  #ok
  Hello World
  THE_END

CONFIGURATION

This Policy is not configurable except for the standard options.

SEE ALSO

Perl::Critic::Policy::ValuesAndExpressions::RequireQuotedHeredocTerminator

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.

2024-03-08 perl v5.38.2