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: 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 From: z007400b@bcfreenet.seflin.lib.fl.us (Ralph Silverman) Subject: Re: Hungarian notation Date: 1996/06/05 Message-ID: <4p4228$e10@nntp.seflin.lib.fl.us>#1/1 X-Deja-AN: 158589395 references: <31999F43.41C67EA6@scn.de> <4o07o9$rfu@seagoon.newcastle.edu.au> <4o1vo3$p2a@news1.ni.net> <4oehnp$onn@goanna.cs.rmit.EDU.AU> <31B0EE2A.59E2@cell.cinvestav.mx> followup-to: comp.lang.ada,comp.lang.c++,comp.lang.c,comp.lang.modula3,comp.lang.modula2,comp.edu,comp.lang.eiffel organization: SEFLIN Free-Net - Broward newsgroups: comp.lang.ada,comp.lang.c++,comp.lang.c,comp.lang.modula3,comp.lang.modula2,comp.edu,comp.lang.eiffel Date: 1996-06-05T00:00:00+00:00 List-Id: Heinz Hemken (hhemken@cell.cinvestav.mx) wrote: : The point of comments in non-trivial software, and in programs that will : be read by many people, is not just to express what isn't clear in the : code itself. : Commercial or in-house software are assets, economically important : assets that no organization can afford to sacrifice or have fail. In : this context, comments should make it exquisitely clear what is going on : at a level understandable by just about anyone who will conceivably be : expected to help evolve or maintain the code. : Sparse comments due to "it's in the code", or because "the language : itself expresses what you need to say" will backfire with certainty one : day. It isn't poetry or literature, though it may often seem so, nor is : it an academic exercise, though many seem to think so. It is something : that MUST function and evolve correctly. In that light, it's probably : better to err in the direction of more comments rather than less. : -- : Heinz Hemken : http://www.cell.cinvestav.mx/hh/bchh.html -- ************begin r.s. response************* comments are ignored, generally, entirely by the system so these may be inaccurate, obsolete, or utterly ignorant and misleading! therefore an extremely defensive viewpoint is needed in dealing with these! as a result... these may reasonably be viewed as a kind of potentially valuable clutter! while a few good comments may be of great value... a large number of these are likely to be more trouble than they are worth! as a suggestion... until an automated means of generating and/or validating these is found... brevity should remain the soul of wit! ************end r.s. response*************** Ralph Silverman z007400b@bcfreenet.seflin.lib.fl.us