Re: Do you spellcheck Code Comments

Subject: Re: Do you spellcheck Code Comments
From: Bruce Byfield <bbyfield -at- axionet -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 12:14:02 -0700


If I had so little to do that I was worrying about spellchecking code comments, I'd be polishing my resume at night, knowing that I'd need it soon. I'd suspect that the company didn't have enough work to keep me on staff.

Code comments are traditionally informal, and no one who uses them cares whether their spelling and grammar are perfect. More importantly, most customers will never see them. And even if your company does share source code with customers, the people who will see the comments are other developers, so chances are they won't care about mistakes, either.
For these reasons, spellchecking seems too trivial to bother with.

There's also a danger that you'll be seen as a busybody who makes unhelpful suggestions. If you're going to deal with code comments at all, it would be more useful to check them for accurate information, or else to suggest that they would be a good place to store information that developers might need later.

--
Bruce Byfield 604-421-7177
http://members.axion.net/~bbyfield

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

References:
RE: Do you spellcheck Code Comments: From: Matt Horn

Previous by Author: Re: Why should I be worried about the merger? NOT
Next by Author: Re: Why should I be worried about the merger? NOT
Previous by Thread: RE: Do you spellcheck Code Comments
Next by Thread: Re: Do you spellcheck Code Comments


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads