Relay-Version: version B 2.10 5/3/83; site utzoo.UUCP
Posting-Version: version B 2.10.1 6/24/83; site druxy.UUCP
Path: utzoo!watmath!clyde!floyd!harpo!ihnp4!drutx!druxy!jas
From: jas@druxy.UUCP (ShanklandJA)
Newsgroups: net.lang
Subject: Re: Forced Commenting - (nf)
Message-ID: <999@druxy.UUCP>
Date: Tue, 21-Feb-84 12:43:37 EST
Article-I.D.: druxy.999
Posted: Tue Feb 21 12:43:37 1984
Date-Received: Wed, 22-Feb-84 02:38:55 EST
References: iuvax.117 <1086@utah-gr.UUCP> <170@cubsvax.UUCP> <1075@drux3.UUCP>
Organization: AT&T Information Systems Laboratories, Denver
Lines: 20

One more semi-pertinent comment on comments:

It has been my experience that if you comment in detail the function of
each data structure ("data structure" here includes all storage objects,
such as scalars, arrays, structures, etc.) and their interactions
at the head of the function or module that uses the data structure,
two things happen:

(1)  You are much more likely to write correct code (I have found "bugs"
     writing out the comment on a data structure before writing a line
     of code!).

(2)  Commenting the *statements* becomes almost entirely unnecessary;
     to a reader who understands the data structures, the actions of
     virtually all the statements become obvious.

Give it a try!

Jim Shankland
..!ihnp4!druxy!jas