Re: Do you spellcheck Code Comments
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
"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:
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.
Do you spellcheck Code Comments: From: John Posada
Search our Technical Writing Archives & Magazine