Re: Code Annotation in HTML pages

Subject: Re: Code Annotation in HTML pages
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 11 Nov 2009 08:55:38 -0800

I wouldn't put anything unprofessional in HTML comments, but I don't
see any problem with housekeeping-type comments (e.g. "this is for
beta releases only, hide for GA").

On Wed, Nov 11, 2009 at 7:13 AM, Paul Hanson <phanson -at- quintrex -dot- com> wrote:
> 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.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
http://www.doctohelp.com/

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. http://www.helpandmanual.com/

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
Code Annotation of the Week: From: Janice Gelb
Re: Code Annotation of the Week: From: quills
Re: Code Annotation of the Week: From: John Posada
Re: Code Annotation of the Week: From: voxwoman
Re: Code Annotation of the Week: From: John Posada
Code Annotation in HTML pages: From: Paul Hanson

Previous by Author: Re: Code Annotation of the Week
Next by Author: Re: Code Annotation of the Week
Previous by Thread: Re: 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


Sponsored Ads