From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on polar.synack.me X-Spam-Level: X-Spam-Status: No, score=-1.3 required=5.0 tests=BAYES_00,INVALID_MSGID autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: fac41,af40e09e753872c X-Google-Attributes: gidfac41,public X-Google-Thread: 1014db,30e368bdb3310fe5 X-Google-Attributes: gid1014db,public X-Google-Thread: f8c65,30e368bdb3310fe5 X-Google-Attributes: gidf8c65,public X-Google-Thread: 109fba,f292779560fb8442 X-Google-Attributes: gid109fba,public X-Google-Thread: 10db24,30e368bdb3310fe5 X-Google-Attributes: gid10db24,public X-Google-Thread: 103376,30e368bdb3310fe5 X-Google-Attributes: gid103376,public X-Google-Thread: 1008e3,30e368bdb3310fe5 X-Google-Attributes: gid1008e3,public From: The Amorphous Mass Subject: Re: Hungarian notation Date: 1996/05/28 Message-ID: #1/1 X-Deja-AN: 157111288 distribution: world references: <31999F43.41C67EA6@scn.de> <319D2278.3F9A@netonecom.net> <4nr50r$jo2@ringer.cs.utsa.edu> <4ns02o$ep3@goanna.cs.rmit.EDU.AU> <4o07o9$rfu@seagoon.newcastle.edu.au> <4o1vo3$p2a@news1.ni.net> <4oattj$408@seagoon.newcastle.edu.au> <4ob5ig$6n0@blackice.winternet.com> <4odnea$20g@blackice.winternet.com> content-type: TEXT/PLAIN; charset=US-ASCII organization: University of Iowa, Iowa City, IA, USA mime-version: 1.0 newsgroups: comp.lang.ada,comp.lang.c++,comp.lang.c,comp.lang.modula3,comp.lang.modula2,comp.edu,comp.lang.eiffel Date: 1996-05-28T00:00:00+00:00 List-Id: On 28 May 1996, Jeff Dege wrote: > On Mon, 27 May 1996 20:25:27 -0500, The Amorphous Mass (robinson@green.weeg.uiowa.edu) wrote: > : On 27 May 1996, Jeff Dege wrote: > : > I'm half-way through an MS program in SE, and I've yet to have a class that > : > discussed issues of this sort. The only place on campus where these issues > : > were discussed was in the office of the student chapter of the ACM. (This > : > was the site of many an informative bull session between undergrads, grads, > : > and the occasional faculty advisor.) > : > : Quality and thoroughness of commenting was 20% of my grade in the first > : two (undergraduate) courses I took, and 10% in the last course I took. > : Needless to say I took to commenting code pretty quickly. > > Were you instructed _to_ comment, or instructed in _what_ to comment? Both. Exactly what and how I was supposed to comment varied from instructor to instructor, but I was consistently required to, for example, put a comment in front of every function explaining what the function takes as parameters, what it does (including explanation of algorithms used, if relevant), and what (if anything) the function returns. My current job has me writing C code in a PL/I shop, and I have to comment exhaustively because only one other person in the place can parse C code. /**James Robinson*********************** "If a fatal error occurs, the program should not be allowed to continue." -- Oracle Pro*C User's Guide *************james-robinson@uiowa.edu**/