From: rfarris@serene.UUCP (Rick Farris)
Subject: Re: comments on comments on comments
Date: 24 Feb 89 09:24:02 GMT [thread overview]
Message-ID: <426@serene.UUCP> (raw)
In-Reply-To: 4534@hubcap.UUCP
In article <4534@hubcap.UUCP> wtwolfe@hubcap.clemson.edu writes:
| I use a tactic which essentially makes comments as inherent a part of
| the code as possible: I make all package, procedure, function, type,
| and variable names as descriptive as reasonably possible.
[some examples deleted]
Yes, this is the only way I've seen documentation that tended to be
maintained with the code. Personally, I'm a proponent of 4th
generation reverse engineering tools to do things like structure
charts, etc, since they are *never* maintained if it has to be done
manually.
| Also, I've learned to type very quickly, through long hard experience. :=)
As the ADAge goes, "Programs are *written* once, but *read* many times."
Rick Farris RF Engineering POB M Del Mar, CA 92014 voice (619) 259-6793
rfarris@serene.cts.com ...!uunet!serene!rfarris serene.UUCP 259-7757
next prev parent reply other threads:[~1989-02-24 9:24 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1813@goofy.megatest.UUCP>
1989-02-10 21:16 ` comments on comments Bob Hathaway
[not found] ` <20233@agate.BERKELEY.EDU>
[not found] ` <9689@ihlpb.ATT.COM>
1989-02-23 2:15 ` Bob Hathaway
1989-02-23 7:22 ` Dave Jones
1989-02-23 22:50 ` Good Design Strategies <Was comments on comments> Bob Hathaway
1989-02-25 1:07 ` Dave Jones
1989-02-26 19:34 ` Rob Jellinghaus
1989-02-27 0:58 ` William Thomas Wolfe,2847,
1989-02-27 15:29 ` John Baugh
1989-02-27 18:29 ` Reuseable Ada components William Thomas Wolfe,2847,
1989-02-28 0:53 ` Good Design Strategies <Was comments on comments> Bob Hathaway
1989-02-28 22:13 ` Dave Jones
1989-03-03 5:45 ` Bob Hathaway
1989-03-08 17:14 ` David P. Schneider
1989-03-11 11:15 ` Stuart H. Ferguson
1989-02-24 1:57 ` comments on comments William Thomas Wolfe,2847,
1989-02-23 20:41 ` comments on comments on reusability Rick Farris
1989-02-24 2:15 ` comments on comments on comments William Thomas Wolfe,2847,
1989-02-24 3:31 ` William A. Bralick
1989-02-24 9:24 ` Rick Farris [this message]
1989-02-25 14:28 ` Robert Claeson
1989-03-09 21:12 ` Rick Clements
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox