Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

Re^3: Perl Best Practices for naming variables

by Tanktalus (Canon)
on Aug 07, 2005 at 14:18 UTC ( #481678=note: print w/replies, xml ) Need Help??

in reply to Re^2: Perl Best Practices for naming variables
in thread Perl Best Practices for naming variables

$ perl -c -e ' my $c_ref; $c_ref[0] = "foo"' -e syntax OK

The moral is that you should always use warnings and strict. But, even if you don't (or can't), $c_ref[0] is still obviously wrong if you're looking at code following the HungDamian naming convention.

(Personally, I think we should come up with a better name than that - Damian may like this one too much. And his publicist may not ;-})

PS - I'm not attempting to convert anyone to this style of naming. I don't use it myself, and I'm not sure I'm going to start, either. Someone asked why Damian would have suggested this, and I answered. Personally, if I were to start, it'd be using an 'r' prefix rather than a '_ref' suffix.

Replies are listed 'Best First'.
Re^4: Perl Best Practices for naming variables
by ff (Hermit) on Dec 20, 2006 at 12:03 UTC
    I smiled when I came upon the '_ref' suggestion, recognizing it as a practice I already followed, sort of. Like you, I don't need the 'ef' part of that tag chewing up valuable line space and/or adding clutter. However, rather than just stopping at '_r', I DO like inserting an extra character to indicate the kind of reference I expect to be referencing. As in:
    _ar for array ref _hr for hash ref _xr for code ref _sr for scalar ref
    The program I'm writing has grown to be many lines and I prefer as much clarity as possible when I reread sections of it. If helps document my intentions which helps when refactoring. And with all the subroutines I end up inventing, it makes for a clear set of expectations of what variables should be passed to the subroutine without having to use prototypes.
    sub foo { my ( $camels_ar, $votes_hr, $count_mechanism_xr, ) = @_;
    Frankly, I wish more books that teach Perl would use this approach because as the learner, it's hard enough trying to understand some new idea without having to fight through the additional ambiguity of "now what's in this variable and why is it written up that way?"

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://481678]
[jedikaiti]: 'ello Monks
[hok_si_la]: bueno

How do I use this? | Other CB clients
Other Users?
Others contemplating the Monastery: (10)
As of 2017-09-22 16:22 GMT
Find Nodes?
    Voting Booth?
    During the recent solar eclipse, I:

    Results (264 votes). Check out past polls.