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=0.1 required=5.0 tests=BAYES_05,INVALID_MSGID autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: 109fba,f292779560fb8442 X-Google-Attributes: gid109fba,public X-Google-Thread: fac41,af40e09e753872c X-Google-Attributes: gidfac41,public X-Google-Thread: 103376,30e368bdb3310fe5 X-Google-Attributes: gid103376,public X-Google-Thread: 1008e3,30e368bdb3310fe5 X-Google-Attributes: gid1008e3,public X-Google-Thread: 10db24,30e368bdb3310fe5 X-Google-Attributes: gid10db24,public X-Google-Thread: f8c65,30e368bdb3310fe5 X-Google-Attributes: gidf8c65,public X-Google-Thread: 1014db,30e368bdb3310fe5 X-Google-Attributes: gid1014db,public From: lr-lang@csm.uwe.ac.uk (Bob Lang 3P21 x3172) Subject: Comments was: Hungarian notation Date: 1996/05/29 Message-ID: <1996May29.111651.27495@pat.uwe.ac.uk>#1/1 X-Deja-AN: 157362713 sender: usenet@pat.uwe.ac.uk (uwe nntp usenet poster) 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> organization: University of the West of England. newsgroups: comp.lang.ada,comp.lang.c++,comp.lang.c,comp.lang.modula3,comp.lang.modula2,comp.edu,comp.lang.eiffel Date: 1996-05-29T00:00:00+00:00 List-Id: In article <4odnea$20g@blackice.winternet.com>, jdege@winternet.com (Jeff Dege) writes: > 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? As a university teacher of programming, I give a lot of emphasis on layout and comments. Students are given a Style Guide-Lines document to help them reach the required standard and this gives lots of helpful hints. Furthermore, programs are marked on several criteria, including comments. The final grade is the LOWEST from all the marking criteria, so that poor comments are not redeemable by high marks elsewhere. They are required to take a Software Design course in parallel with the programming course and the work for the two courses are tied together. In this way I hope to encourage good S/W Engineering principles from day one. Bob ~ ~~~ ~~~~ ~~ ~~~ ~~ ~~ ~~ ~~~~~ ~~~~ __ ~~ ~~ ~~~ ~ ~~~~~~~~~ ~~~~~~~~~~~ ~~~~ ~~~~ ~~~~~ ~~~~ _