Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re^2: The joys of bad code

by Happy-the-monk (Monsignor)
on Oct 26, 2004 at 09:31 UTC ( #402514=note: print w/ replies, xml ) Need Help??


in reply to Re: The joys of bad code
in thread The joys of bad code

i=i+1;

I certainly see this in Perl all the time:
    $self->total( $self->total + 1 );

These habits just never die.

Cheers, Sören


Comment on Re^2: The joys of bad code
Re^3: The joys of bad code
by Limbic~Region (Chancellor) on Oct 26, 2004 at 11:14 UTC
    Happy-the-monk,
    This isn't quite the same thing. Unless you make the total method lvaluable, neither
    $self->total++; # nor $self->total = $self->total + 1;
    will work. I think the point wasn't about incrementing a variable by one, but feeling the need to document it. I do see the point in documenting it (not in what the code does, but why it does it), but to each their own.

    Cheers - L~R

      I do see the point in documenting it (not in what the code does, but why it does it)

      So this is off topic: bad documentation does not bad code make.

      Documenting what the code does isn't bad by itself, it just isn't needed at all if the people supposed to be reading the documentation can program already.

      Imagine they can't, that kind of documentation might help them understand what's happening.

      Cheers, Sören

        If they can't program already, why are they digging around in code?

        Over-documentation does make bad code. The documentation in the cases above is highly redundant with the actual code. Humans like some redundancy to keep communication robust, but there is a threshold where it just becomes silly. Flowerbox comments like the above go well past that point.

        "There is no shame in being self-taught, only in not trying to learn in the first place." -- Atrus, Myst: The Book of D'ni.

Re^3: The joys of bad code
by dws (Chancellor) on Oct 27, 2004 at 20:48 UTC
    I certainly see this in Perl all the time:
      $self->total( $self->total + 1 );

    Before automatically writing this off as being bad code, consider:

    • The class has--or appears to have--a public accessor and a public mutator for total.
    • The mutator is free to do stuff other than setting total. For example, it might log that fact that total has changed, or it might notify other agents who have registered interest in that aspect of the the instance.
    • Subclasses are free to add interesting behavior to mutations of total, even if those mutations are generated internal to the class.

    By coding this as   $self->{total}++;
    you lose these benefits. Sometimes these benefits aren't important, sometimes they're vital. That said, perhaps   $self->increment_total;
    might have been better.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://402514]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (7)
As of 2014-09-15 03:04 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite cookbook is:










    Results (145 votes), past polls