Re: Code Annotation in HTML pages

Subject: Re: Code Annotation in HTML pages
From: freetaco -at- gmail -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 11 Nov 2009 17:08:44 +0000

I use php comments that won't print to the end user. That way, I can search them on my own and the user can't see them.

-david
------Original Message------
From: Paul Hanson
Sender: techwr-l-bounces+freetaco=gmail -dot- com -at- lists -dot- techwr-l -dot- com
To: TECHWR-L
Subject: Code Annotation in HTML pages
Sent: Nov 11, 2009 9: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?

Paul Hanson
Technical Writer
Quintrex Data Systems http://www.quintrex.com
email: phanson at quintrex.com



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

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 freetaco -at- gmail -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/freetaco%40gmail.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



Sent from my Verizon Wireless BlackBerry
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


Previous by Author: Technical Communication for Peace and Justice
Next by Author: Re: Can we start a sentence with "or" or "and" in a manual
Previous by Thread: Adobe layoffs
Next by Thread: Anonyponymous


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

Sponsored Ads


Sponsored Ads