Re: Deciphering cryptic help messages

Subject: Re: Deciphering cryptic help messages
From: Stuart Burnfield <slb -at- FS -dot- COM -dot- AU>
Date: Tue, 17 Oct 1995 11:38:39 +0800

Also sprach Geoff Hart <geoff-h -at- MTL -dot- FERIC -dot- CA>:

> 2. (Likely) ... If you understand the
> programming language, you might also be able to extract
> some meaning from the _comments_ added to the source code,
> particularly if the development manager enforces good
> commenting practices (i.e., embedding explanations for
> program logic, variables, etc. directly in the source code).

Geoff's advice is good, but beware: the comments don't always get updated
when the code is updated. If you're working on a version 1.0 the comments
should be reliable. The higher the version number, the more out-of-date
the comments will be.

Stuart Burnfield (slb -at- fs -dot- com -dot- au) Voice: +61 9 328 8288
Functional Software Fax: +61 9 328 8616
PO Box 192
Leederville, Western Australia, 6903

Previous by Author: Re: SGML
Next by Author: Letting them down gently
Previous by Thread: Tech Writer Position
Next by Thread: LUCY.FINDLAY.EDU

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

Sponsored Ads