Comments in Code

Subject: Comments in Code
From: "Crimmin, Peter" <Peter -dot- Crimmin -at- scansoft -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 1 Oct 2004 08:42:07 -0400

One consideration is that the author needs expertises in code sharing. Most
engr organization use tools like ClearCase, CVS, etc to manage their code.
This requires the following knowledge:

* How to check out, check in code modules.
* How to "tag" modules with specific release information.
* How to merge changes when someone else has modified the same file that you

Here's an example of how I add comments to code:

1. I write reference documentation about configuration parameters.
2. Not all params are documented (some are internal-use only).
3. But un-documented params appear in the installed configuration files.
4. I add comments to the config files to define the un-doc'd params.


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed!

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.

Previous by Author: Re: PageMaker vs. Framemaker (those who've used both)
Next by Author: Extracting text from Adobe file
Previous by Thread: PDFMaker - custom page size solution
Next by Thread: I need a user-friendly term?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads