Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

Re: The difficulties of commenting code

by andreychek (Parson)
on Jun 29, 2001 at 21:53 UTC ( #92736=note: print w/ replies, xml ) Need Help??


in reply to The difficulties of commenting code

If I may offer a humble observation -- your post here is based on code where you update parameters, but (in your words) you find yourself "too lazy" to update the comments in the subroutine.

First off -- I think you and several others are correct that nothing beats nice, descriptive variable names.. I particularly like the idea of using hashes when there are several parameters involved.

However, I also feel that commenting your API is quite important, and you can't always get every necessary detail about a parameter into it's own name.. and if you can, I think you're names will be quite long :-) I believe the Perl term for what you are doing is called "false laziness". The objective is to be lazy overall, where you have to do the least amount of work. When you are maintaining your code, as soon as you find yourself needing to dig up info on a parameter, where a comment could have saved you, I think you may be missing out on the benefits of the Perl virtues. Furthermore, while you may understand it -- you coworkers may not.. job security is nice, but just remember that one day, you'll be the one needing to learn somebody elses code :-)
-Eric


Comment on Re: The difficulties of commenting code
Re: Re: The difficulties of commenting code
by Henri Icarus (Beadle) on Jun 30, 2001 at 01:14 UTC
    Good point. My lazyness probably is the false kind, because indeed it's gotten me into trouble. I never have trouble maintaining the comments inside the subroutine, it's that "header block" that gets me!

    -I went outside... and then I came back in!!!!

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others avoiding work at the Monastery: (15)
As of 2014-10-30 19:14 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    For retirement, I am banking on:










    Results (208 votes), past polls