#Value of Comments
11-May-90 11:34:56
Sb: #103850-#Value of Comments
Fm: Vic Wagner 76046,3004
To: Mike Spille/Manx 71545,1466
Mike,
Back in the 'early days' I was assigned to the tail end of a project to
add some 'last minute requirements additions'. The entire project (it was
an auto-routing CAD/CAM package for wire-wrap boards) was written in
assembly. Remember, this was the _early_ days…the only HLL we had was
FORTRAN. At any rate, I was handed the listing of the program I would need
to modify (about 2" thick 11" x 14-7/8"). I decided that I would attempt
to derive the mechanism of the auto-routing algorithm by covering the
comments and look only at the 'code'. I had 2 pages of 'listing' open
(maybe 100+ lines) and had been studying it for about 20 minutes when a
pattern finally 'clicked'. I thought I knew what ONE (1) of the
instructions was doing (still in the dark about the entire algorithm tho).
So, I decided to see if my 'guess' was correct. I carefully lifted my
right arm from the listing…and sure enough the comment verified my
conjecture. I was delighted (batting 1 for 1) but decided that maybe I
ought to read the comments since deducing the meaning of 1% of the module
in 20+ minutes was not spectacular progress. Unfortunately, it was the
ONLY comment in the ENTIRE module. I admit to a bit of disappointment at
discovering this as I had just received a light 'reprimand' for _my_ dearth
of comments.
Victor A. Wagner, Jr.