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.4 required=5.0 tests=AC_FROM_MANY_DOTS,BAYES_00 autolearn=no autolearn_force=no version=3.4.4 X-Google-Language: ENGLISH,ASCII-7-bit X-Google-Thread: 10ad19,23963231b5359f74 X-Google-Attributes: gid10ad19,public X-Google-Thread: 103376,23963231b5359f74 X-Google-Attributes: gid103376,public X-Google-Thread: 1073c2,23963231b5359f74 X-Google-Attributes: gid1073c2,public X-Google-Thread: 101deb,23963231b5359f74 X-Google-Attributes: gid101deb,public X-Google-Thread: 107a89,23963231b5359f74 X-Google-Attributes: gid107a89,public X-Google-Thread: 11440e,23963231b5359f74 X-Google-Attributes: gid11440e,public X-Google-Thread: 10a146,23963231b5359f74 X-Google-Attributes: gid10a146,public X-Google-ArrivalTime: 2001-06-08 06:45:29 PST Path: archiver1.google.com!newsfeed.google.com!sn-xit-02!supernews.com!newsfeed.direct.ca!look.ca!btnet-peer0!btnet!grolier!newsfeed.planete.net!psinet-france!psiuk-f4!psiuk-p4!uknet!psiuk-n!news.pace.co.uk!nh.pace.co.uk!not-for-mail From: "Marin David Condic" Newsgroups: comp.lang.ruby,comp.lang.ada,comp.lang.awk,comp.lang.clarion,comp.lang.java.programmer,comp.lang.pl1,comp.lang.vrml Subject: Re: Commenting code Date: Fri, 8 Jun 2001 09:27:30 -0400 Organization: Posted on a server owned by Pace Micro Technology plc Message-ID: <9fqjs4$mhv$1@nh.pace.co.uk> References: <9f8b7b$h0e$1@nh.pace.co.uk> <9f8r0i$lu3$1@nh.pace.co.uk> <9fgagu$6ae$1@nh.pace.co.uk> <9fjgha$blf$1@nh.pace.co.uk> <35mqhtkdfma2rggv1htcaq6vfn2ihs67a1@4ax.com> <3B1E1452.BAFAAB7F@baesystems.com> <3B1E4B93.7FB8A94D@lmtas.lmco.com> <3B1F3704.C7E0D03A@brighton.ac.uk> <3b1ffa9a.10556848@pubnews.netcom.net.uk> NNTP-Posting-Host: 136.170.200.133 X-Trace: nh.pace.co.uk 992006852 23103 136.170.200.133 (8 Jun 2001 13:27:32 GMT) X-Complaints-To: newsmaster@pace.co.uk NNTP-Posting-Date: 8 Jun 2001 13:27:32 GMT X-Priority: 3 X-MSMail-Priority: Normal X-Newsreader: Microsoft Outlook Express 5.50.4522.1200 X-MimeOLE: Produced By Microsoft MimeOLE V5.50.4522.1200 Xref: archiver1.google.com comp.lang.ruby:10486 comp.lang.ada:8402 comp.lang.awk:2895 comp.lang.clarion:21433 comp.lang.java.programmer:74746 comp.lang.pl1:900 comp.lang.vrml:3638 Date: 2001-06-08T13:27:32+00:00 List-Id: Good point. Had it been called something like: procedure Get_Postal_Code ( Zip_Plus_5_Code : out US_Postal_Code_Type) ; even more information would be communicated in the source code. A comment at that point saying "Get the US postal code..." would tell you nothing new or useful. MDC -- Marin David Condic Senior Software Engineer Pace Micro Technology Americas www.pacemicro.com Enabling the digital revolution e-Mail: marin.condic@pacemicro.com Web: http://www.mcondic.com/ "Jane Williams" wrote in message news:3b1ffa9a.10556848@pubnews.netcom.net.uk... > On Thu, 07 Jun 2001 21:58:10 GMT, Roedy Green > wrote: > > >however, sometimes there is nothing really useful you could add: > >e.g. > > > >"getZipPlusFive get the US Zip+5 postal code." > > I'd say that was useful comment, myself. Never having heard of > anything called "zip+5", I would not have guessed that it was a postal > code. Two words of added information: great! If all you'd said was > "gets the zip plus five code" then I'd agree that the comment would be > useless. > > >