Re: Code comments as Documentation

Subject: Re: Code comments as Documentation
From: Leigh Price <price_leigh -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 29 Sep 2004 13:06:27 -0700 (PDT)


Personally, I would not want to edit the code,
directly or indirectly. Even though I consider myself
capable of applying such edits without mucking things
up, I think that territory belongs to developers. I'm
sure
there are special characters that could wreak havoc on
the code, even if those characters were commented out.
Plus, if something went wrong, the lowly doc person
would be the most likely scapegoat. I know that if I
asked for that kind of access here, we'd be laughed
at.

Personally, I'd let sleeping dogs lie. Here, those
kind of comments are not meant for public consumption.
I would consider myself a "view only" user of those
comments.

Leigh


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

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

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! 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.



Follow-Ups:

Previous by Author: Re: Action(s) menu
Next by Author: Re: Code comments as Documentation
Previous by Thread: Re: Code comments as Documentation
Next by Thread: Re: Code comments as Documentation


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


Sponsored Ads