Re: Do you spellcheck Code Comments

Subject: Re: Do you spellcheck Code Comments
From: Jeffrey Osier-Mixon <jefro -at- jefro -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 11:56:23 -0700


The latter option is the most correct. In fact, anything to promote communication between writer and developer can be considered the correct option.

John Posada wrote:

I'm using an application called CAST that outputs reports about code.
Once of the outputs is any code comments.

I'm importing the report into FM. Natuarally, I'm spell checking the
document and sometimes I get a hit on the code comment, similar to
the following:

"Exectute on all entities if no entity type specified".

In the document, would you correct the spelling of "Exectute" or
would you send a note to the developer. wait for him to fix it, and
if he does, then make the change in the doc?.




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

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.



References:
Do you spellcheck Code Comments: From: John Posada

Previous by Author: Re: Trouble finding work
Next by Author: Re: What Can We Do?
Previous by Thread: 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