TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
It depends on where you work, but if the code comments are being routinely
exported to documentation (i.e., being seen by external eyes), then a typo
counts as a bug of the minor variety, and warrants either an email to the
developer or a bug ticket with his name on it, depending on the way your
company works. As you are exporting this report, it's a correction you'll
have to make every time if it doesn't get fixed. But if it's a one-time deal,
just fix the typo in your doc and move on; if not, do the email and
correction now.
In my last job I routinely edited code comments for JavaDoc in the source -
but this was a formal arrangement and everyone knew I'd be poking at the code
and were okay with it. Made fixing typos a bit easier though. :D
Bill S. Guttman
TW Monkey
-----Original Message-----
From: John Posada
Subject: 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 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.
