Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid
 
PerlMonks  

Re: Code review on script site

by rchiav (Deacon)
on Nov 24, 2001 at 09:08 UTC ( #127232=note: print w/replies, xml ) Need Help??


in reply to Code review on script site

Great idea. Couple comments though:

You mentioned +2 for excessive comments. I'd personally -- for excessive comments. Excessive means that it's more than is needed, which to me means something like:

#loops through all the lines in a #file and prints them out foreach $line (@file) { print $line; }
I think the loop is self commenting enough (not that you'd ever use that). It bothers me when people over comment. You spend more time reading about what each line does than you do reading the program. Maybe something subjective like "effective use of commenting"?

Also, I think beyond the cut and dry "points", there should be a human critique on the style, flow, and as always, what could be better.

Just my nickle.
Rich

Replies are listed 'Best First'.
Re: Re: Code review on script site
by Jazz (Curate) on Nov 24, 2001 at 11:23 UTC

    rchiav, thank you for the comment revision -- the outline has been updated.

    Also, I think beyond the cut and dry "points", there should be a human critique on the style, flow, and as always, what could be better.

    I definitely agree there, but believe that such a review should be the responsibility of the author to request or hire someone to do.

    The author must take the incentive to build on the basic review we're going to do at no cost for them (but at a cost to us). They'll need to care enough about their own code, reputation, and skill to pursue (and learn from) a thorough code review.

    As much as we may like to, we can't do it all for them :)

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others having an uproarious good time at the Monastery: (2)
As of 2021-07-27 02:18 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?