Relay-Version: version B 2.10 5/3/83; site utzoo.UUCP
Path: utzoo!utgpu!water!watmath!clyde!rutgers!husc6!cmcl2!brl-adm!adm!evh@vax1.acs.udel.EDU
From: evh@vax1.acs.udel.EDU
Newsgroups: comp.lang.c
Subject: documentation standards for C
Message-ID: <9500@brl-adm.ARPA>
Date: Sun, 27-Sep-87 14:28:37 EDT
Article-I.D.: brl-adm.9500
Posted: Sun Sep 27 14:28:37 1987
Date-Received: Sun, 27-Sep-87 23:40:59 EDT
Sender: news@brl-adm.ARPA
Lines: 36


There comes a time when a programmer will have to debug some one
else's C code(or probably anyway). A professor where i used
to go to college has created some documentation standards.
I added my own opinions(etc. etc....). I am looking for
some criticism's,opinions on how you think code should
be indented(switch's, if/then brackets etc. etc.), module headers
and function headers, using your particular style/standards.
Here's a question just to start:
What purpose does the so-called k&r indenting style serve:
(personally, i dis-like it because its hell to debug).

if (x == blah) {
   zip = zap;
   big = deal;
}
else {
   so = what;
   friz = golf;
}

As opposed to:
if (x == blah)
   {
   zip = zap;
   big = deal;
   }
else
   {
   so = what;
   friz = golf;
   }


Send them to:
evh@vax1.acs.udel.edu