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=AC_FROM_MANY_DOTS,BAYES_00, INVALID_MSGID autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: f8c65,30e368bdb3310fe5 X-Google-Attributes: gidf8c65,public X-Google-Thread: fac41,af40e09e753872c X-Google-Attributes: gidfac41,public X-Google-Thread: 109fba,f292779560fb8442 X-Google-Attributes: gid109fba,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: 1014db,30e368bdb3310fe5 X-Google-Attributes: gid1014db,public From: Chris Kuan Subject: Re: Hungarian notation Date: 1996/05/29 Message-ID: <31ACB6DB.221A@bhp.com.au>#1/1 X-Deja-AN: 157280765 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: BHP Information Technology 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 x-mailer: Mozilla 2.0 (Win16; I) Date: 1996-05-29T00:00:00+00:00 List-Id: Richard A. O'Keefe wrote: > 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? > What about something like, "Use comments to fill in the gaps between the code". Of course, now you'll have to explain exactly what you intend by this, but at least it's short and memorable, even if it doesn't appear to make much sense at face value :-) - Chris.