Re: Do you spellcheck Code Comments

Subject: Re: Do you spellcheck Code Comments
From: "Guy K. Haas" <guy -at- hiskeyboard -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 20 Apr 2005 12:28:48 -0700


Lately, APIs are often documented by extracting the comments specifically entered into them for tools like Doxygen and Javadoc to gather and publish -- typically as HTML. Granted, that's only the Reference material; user guide info would still need to be provided, but believe me customers ARE reading such comments.

--Guy K. Haas
Software Exegete in Silicon Valley

Bruce Byfield wrote:
...

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.
...


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

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:
RE: Do you spellcheck Code Comments: From: Matt Horn
Re: Do you spellcheck Code Comments: From: Bruce Byfield

Previous by Author: Re: Do you spellcheck Code Comments
Next by Author: Re: Difference between developer guide content and reference information
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