Perl::...seSubs(3pm)

📦
version 1.119 · 3 versions
, in epel 10

Okay bestie, welcome to the Perl::...seSubs(3pm) page — it's part of User Contributed Perl Documentation, and we're about to get into some naming-convention business. Grab your iced coffee 🍓 because this one is all about not doing mixed-case sub names.

✨ NAME ✨

This page is for Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseSubs — the policy that says write sub my_function{} instead of sub MyFunction{}. Yes, lowercase with underscores is the moment 💅.

🦋 AFFILIATION 🦋

This Policy is part of the Perl::Critic::Deprecated distribution. So it's giving "still here, but deprecated" energy.

🌸 DESCRIPTION 🌸

Conway's recommended naming convention is to use lower-case words separated by underscores. Well-recognized acronyms can be in ALL CAPS, but must be separated by underscores from other parts of the name.

Here's the vibe check on the examples:

sub foo_bar{}   #ok
sub foo_BAR{}   #ok
sub FOO_bar{}   #ok
sub FOO_BAR{}   #ok

sub Some::Class::foo{}   #ok, grudgingly

sub FooBar {}   #not ok
sub FOObar {}   #not ok
sub fooBAR {}   #not ok
sub fooBar {}   #not ok

The not-ok ones are not it, bestie.

🎀 CONFIGURATION 🎀

This Policy is not configurable except for the standard options. That's it — no extra knobs, no secret settings, just the standard options. Periodt.

🌈 SEE ALSO 🌈

  • Perl::Critic::Policy::NamingConventions::ProhibitMixedCaseVars — go read that one too, bestie.
Heads up: This policy is deprecated. Its functionality has been superseded by Perl::Critic::Policy::NamingConventions::Capitalization. So maybe don't build your whole personality around it, iykyk.

👑 AUTHOR 👑

Jeffrey Ryan Thalhammer <thaljef@cpan.org> — the author, iconic.

Copyright (c) 2005-2013 Jeffrey Ryan Thalhammer. 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.

And that's the whole page, bestie. Signing off with perl v5.40.0, dated 2023-01-20, from the Perl::...seSubs(3pm) page. Stay underscored, stay iconic 💖✨🎀

📦 where this page comes from