home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #30 / NN_1992_30.iso / spool / comp / software / 4920 < prev    next >
Encoding:
Text File  |  1992-12-13  |  1.7 KB  |  41 lines
  1. Newsgroups: comp.software-eng
  2. Path: sparky!uunet!enterpoop.mit.edu!spool.mu.edu!mixcom.com!amby
  3. From: amby <amby@mixcom.mixcom.com>
  4. Subject: Re: C code Layout
  5. Organization: Milwaukee Internet Xchange BBS, Milwaukee, WI U.S.A.
  6. Distribution: usa
  7. Date: Sun, 13 Dec 1992 15:24:30 GMT
  8. Message-ID: <1992Dec13.152430.6370@mixcom.com>
  9. References: <1992Dec12.122453.8582@seq.uncwil.edu>
  10. Keywords: C code layout
  11. Sender: ttvvtt@mixcom.com (Donald Amby)
  12. Lines: 27
  13.  
  14. In <1992Dec12.122453.8582@seq.uncwil.edu> herbst@seq.uncwil.edu (R.T. Herbst) writes:
  15.  
  16. >While directing the eforts of 125 people in producing the 
  17. >A Data switching system for the Bell System- Good ol'
  18. >Ma bell-- I asked for a sample of code. I founr the comments to
  19. >be utter nonsense,. If one removed the code, the comments made no sense.
  20.  
  21.     Excellent point!   The comments SHOULD make sense without the code.
  22.     I personally write code by doing the comments first.  If I cannot
  23.     describe in clear concise sentences what I am attempting to do,
  24.     then I obviously do not understand the problem.
  25.  
  26.     I then add the code as I get the details of the implementation 
  27.     worked out.
  28.  
  29. >It was better to let the code speak for itself. If fact the code
  30. >was hidden in by the comments. Certainly we need well commented code.
  31.  
  32.     Organizations that are serious about quality should address the
  33.     comments as part of any code review.  Of course, if there are
  34.     no code reviews you will never see the comments until you have
  35.     to make changes to the code.
  36. -- 
  37. Donald E. Amby
  38.     don@amby.mixcom.com   (for short mail)        (414)797-6713 (voice)
  39.     amby@eisner.decus.org (for lengthy mail)      (414)797-6533 (FAX)
  40.     Harnischfeger Engineers, Inc., P.O.Box 1512, Milwaukee, WI 53201-1512
  41.