Your skill will accomplish what the force of many cannot |
|
PerlMonks |
Re: What makes a comment "obnoxious"?by tubaandy (Deacon) |
on Sep 10, 2007 at 02:24 UTC ( [id://637974]=note: print w/replies, xml ) | Need Help?? |
I'm not a big fan of lots of octarands in comments, but that's my preference. This discussion got me thinking, though. For lots of different professions, there is a style standard that is followed for publications. The American Chemical Society has a style standard, the American Psychological Association has a different one, and I'm sure that other professional entities do as well (I used ACS and APA as those are 2 I've worked in and I could think of off the top of my head, not to leave anyone else out.) While I think folks generally abide by "It's good to comment your code for other's benefit", isn't this more something that should be discussed and agreed to in the community (if that is important enough to act on)? I do realize the difference between professional publications and scripting or programming. I don't really have an answer here, just wondering what others think. Update:I looked up "octarand", and poqui is correct! s/octarand/octothorpe/ We used this term in grad school, apparently I shouldn't have blindly believed my research advisor. ;) Mea culpa, and thanks poqui!
tubaandy
In Section
Seekers of Perl Wisdom
|
|