Beefy Boxes and Bandwidth Generously Provided by pair Networks
good chemistry is complicated,
and a little bit messy -LW
 
PerlMonks  

Re: What makes a comment "obnoxious"?

by Your Mother (Archbishop)
on Sep 08, 2007 at 17:46 UTC ( [id://637855]=note: print w/replies, xml ) Need Help??


in reply to What makes a comment "obnoxious"?

Comments are a form of design + writing. So they are impossible to programmatically correct/critique. What can be checked, and is the issue with a lot of Perl preferences, is the regularity and verbosity.

Perhaps checking POD:comment ratio and recommending (at a LOW level) more POD if there is little/none but lots of long-ish comments. Perhaps scanning for run-on comments. Do the comments seem to come in than 2 (some "block" style, and inline) styles in the code; probably 2 is plenty. Perhaps putting a spell checker, if it's installed, on the comments and providing low level verbosity about what might be misspelled. Verbose feedback is sometimes nice even if you don't agree with all of it.

I wasn't sure how I felt about Perl::Critic for a long time but the more I use it, the more I like it as a sort of automated code review + anal retentive, somewhat stupid, pair coding partner.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others lurking in the Monastery: (4)
As of 2024-04-16 12:42 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found