home *** CD-ROM | disk | FTP | other *** search
- Path: sparky!uunet!ogicse!emory!gatech!concert!seq!herbst
- From: herbst@seq.uncwil.edu (R.T. Herbst)
- Newsgroups: comp.software-eng
- Subject: C code Layout
- Keywords: C code layout
- Message-ID: <1992Dec12.122453.8582@seq.uncwil.edu>
- Date: 12 Dec 92 12:24:53 GMT
- Article-I.D.: seq.1992Dec12.122453.8582
- Organization: Univ. of North Carolina @ Wilmington
- Lines: 16
-
- While directing the eforts of 125 people in producing the
- A Data switching system for the Bell System- Good ol'
- Ma bell-- I asked for a sample of code. I founr the comments to
- be utter nonsense,. If one removed the code, the comments made no sense.
- It was better to let the code speak for itself. If fact the code
- was hidden in by the comments. Certainly we need well commented code.
- Too many comments that try to say what the code is saying are IMHO
- distracting. The code in this case was assembler. Since that time
- higher level languages came into use. In particular C language.
- My philosophy is to let the language speak for itself. Add comments
- where necessary. Again while directing the efforts of hundreds of
- people on the Safequard Anti-Balistic Missile System, we set standards
- for commenting that let the code be seen. The project met its objectives
- and schedule -- one of the few in that time frame.
- Flame on and damned be he or she who flames out.
- herbst@seq.uncwil.edu
-