Beefy Boxes and Bandwidth Generously Provided by pair Networks
Welcome to the Monastery
 
PerlMonks  

Re: Re: Re: IYHO, what do you consider good code?

by logan (Curate)
on Jun 13, 2003 at 16:31 UTC ( #265727=note: print w/ replies, xml ) Need Help??


in reply to Re: Re: IYHO, what do you consider good code?
in thread IYHO, what do you consider good code?

Sure, for a simple sub like the one I used as an example. But that's like saying we wouldn't need a big table of contents if only people wouldn't write long books or if people wrote clearly we wouldn't need synopsis or abstracts. Sure, it probably isn't necessary to have a 6 line header for a 6 line sub, but if the sub runs to 20-30 lines, I'd rather have the header.

The idea is that I'm trying to make it easy to follow program flow. Two years later I want to be able to look at it and instantly see what it does and how it should be called.

-Logan
"What do I want? I'm an American. I want more."


Comment on Re: Re: Re: IYHO, what do you consider good code?
Replies are listed 'Best First'.
Re: Re: Re: Re: IYHO, what do you consider good code?
by adrianh (Chancellor) on Jun 15, 2003 at 00:08 UTC
    if the sub runs to 20-30 lines, I'd rather have the header

    Obviously if it works for you...

    However, if it were me and the sub ran to 20-30 lines that I couldn't understand without half a dozen lines of comments I'd refactor it into a larger number of smaller subs - each of which I could understand without half a dozen lines of comments.

    I doing code maintenance I tend to ignore comments, since I find that they're out-of-sync with the code half of the time.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (6)
As of 2015-07-29 09:58 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









    Results (263 votes), past polls