Re: Code Annotation in HTML pages

Subject: Re: Code Annotation in HTML pages
From: Craig Haiss <craighaiss -at- yahoo -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Wed, 11 Nov 2009 07:37:51 -0800 (PST)

Yup, I often put comments in the HTML source code for help topics. Usually they are just reminders to add more information during a future update.

Hopefully any user willing to look under the hood already knows the purpose of code comments, and won't be too critical of them. However, I definitely think it's worthwhile to search for any strange commments prior to publishing the help. This is a great step to add to your pre-publish checklist.

Craig Haiss

--- On Wed, 11/11/09, Paul Hanson <phanson -at- Quintrex -dot- com> wrote:

> From: Paul Hanson <phanson -at- Quintrex -dot- com>
> Subject: Code Annotation in HTML pages
> To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
> Date: Wednesday, November 11, 2009, 10:13 AM
> As a side note to the thread about
> programmers putting funny comments in their source code, do
> any of you who create HTML-based Help put comments in your
> pages? Do you worry about your users right-clicking,
> selecting View Source and seeing your comments?
> I routinely include a comment regarding what project is
> associated with a specific change. I find it easier to
> search for that project number if I'm researching
> something.
> What do you do?


Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:

Help and Manual 5: The all-in-one help authoring tool. Full support for
team authoring with multi-user editing - both directly and in combination
with VSS-compatible source control systems.

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:

Code Annotation in HTML pages: From: Paul Hanson

Previous by Author: Re: Can I have content in a RoboHelp project that updates automatically when an external "source" file is updated?
Next by Author: UI designer job
Previous by Thread: Code Annotation in HTML pages
Next by Thread: Re: Code Annotation in HTML pages

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

Sponsored Ads