Re: Do you spellcheck Code Comments

Subject: Re: Do you spellcheck Code Comments
From: Bill Swallow <techcommdood -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 22:45:07 -0400

We (my group of writers) are in the code, and yes, we fix it when it
needs fixing. Of course we do this because we build our SDK docs from
the code comments (.NET and Java) and we expect that any code visible
to a customer should be well-done in all respects.

On 4/20/05, John Posada <jposada01 -at- yahoo -dot- com> 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?.
> John Posada
> Senior Technical Writer


Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:

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 for more resources and info.

Do you spellcheck Code Comments: From: John Posada

Previous by Author: Re: Online Help Tool / Process Recommendation
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