home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #30 / NN_1992_30.iso / spool / comp / software / 5005 < prev    next >
Encoding:
Text File  |  1992-12-16  |  1.6 KB  |  35 lines
  1. Newsgroups: comp.software-eng
  2. Path: sparky!uunet!psinntp!dscope!jld
  3. From: jld@datascope.com (Jay L. Davis)
  4. Subject: Re: C code Layout
  5. Message-ID: <1992Dec15.160408.7367@datascope.com>
  6. Keywords: C code layout
  7. Organization: Datascope Corp.
  8. References: <1992Dec12.122453.8582@seq.uncwil.edu>
  9. Date: Tue, 15 Dec 1992 16:04:08 GMT
  10. Lines: 23
  11.  
  12. In article <1992Dec12.122453.8582@seq.uncwil.edu> herbst@seq.uncwil.edu (R.T. Herbst) writes:
  13. >While directing the eforts of 125 people in producing the 
  14. >A Data switching system for the Bell System- Good ol'
  15. >Ma bell-- I asked for a sample of code. I founr the comments to
  16. >be utter nonsense,. If one removed the code, the comments made no sense.
  17. >It was better to let the code speak for itself. If fact the code
  18. >was hidden in by the comments. Certainly we need well commented code.
  19. >Too many comments that try to say what the code is saying are IMHO
  20. >distracting. The code in this case was assembler. Since that time
  21. >higher level languages came into use. In particular C language.
  22. >My philosophy is to let the language speak for itself. Add comments
  23. >where necessary. Again while directing the efforts of hundreds of
  24. >people on the Safequard Anti-Balistic Missile System, we set standards
  25. >for commenting that let the code be seen. The project met its objectives
  26. >and schedule -- one of the few in that time frame. 
  27. >Flame on and damned be he or she who flames out.
  28.  
  29. About time I heard some common sense in this discussion. One other point that
  30. is real important, if your code is a maze, you need a detailed map. If it
  31. is organized (designed) well, you don't have to explain it as much, it should
  32. be obvious.
  33.  
  34. ---Jay Davis
  35.