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: 109fba,f292779560fb8442 X-Google-Attributes: gid109fba,public X-Google-Thread: fac41,af40e09e753872c X-Google-Attributes: gidfac41,public X-Google-Thread: f8c65,30e368bdb3310fe5 X-Google-Attributes: gidf8c65,public X-Google-Thread: 103376,30e368bdb3310fe5 X-Google-Attributes: gid103376,public X-Google-Thread: 1008e3,30e368bdb3310fe5 X-Google-Attributes: gid1008e3,public X-Google-Thread: 1014db,30e368bdb3310fe5 X-Google-Attributes: gid1014db,public X-Google-Thread: 10db24,30e368bdb3310fe5 X-Google-Attributes: gid10db24,public From: ENGR@GSSI.MV.COM (Michael Furman) Subject: Re: Hungarian notation Date: 1996/05/29 Message-ID: #1/1 X-Deja-AN: 157403189 x-nntp-posting-host: gssi.mv.com references: <31999F43.41C67EA6@scn.de> <4o07o9$rfu@seagoon.newcastle.edu.au> <4o1vo3$p2a@news1.ni.net> <4oehnp$onn@goanna.cs.rmit.EDU.AU> content-type: Text/Plain; charset=US-ASCII organization: GSSI 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-29T00:00:00+00:00 List-Id: In article <4oehnp$onn@goanna.cs.rmit.EDU.AU>, ok@goanna.cs.rmit.EDU.AU says... > >I like reducing things to slogans. >I haven't been able to come up with a good one for this. >What I say is > "Your comments should tell a human reader precisely the > things s/he needs to understand the purpose and operation > of the module but are not obvious from the code." >This is the right stuff, but it needs to be said better. >Can anyone come up with a really memorable way of expressing this? > I am afraid it is impossible because your rule is a quite ambigious. I generally agree with it, but every time we need to define what "obvious" mean. For which kind of person? (what level of knowledge of programming, this particular language, problem domain, math (if related), design of this software ...)? And for what level of anderstanding (what is it, how to use this module, how it works, some kind of proof of its correctness). I just want to say, that IMO it is not so easy. I tried to define such rule many times but never was satisfied. --------------------------------------------------------------- Michael Furman, (603)893-1109 Geophysical Survey Systems, Inc. fax:(603)889-3984 13 Klein Drive - P.O. Box 97 engr@gssi.mv.com North Salem, NH 03073-0097 71543.1334@compuserve.com ---------------------------------------------------------------