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.3 required=5.0 tests=BAYES_00, REPLYTO_WITHOUT_TO_CC 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: 10a146,23963231b5359f74 X-Google-Attributes: gid10a146,public X-Google-Thread: 1073c2,23963231b5359f74 X-Google-Attributes: gid1073c2,public X-Google-Thread: 107a89,23963231b5359f74 X-Google-Attributes: gid107a89,public X-Google-Thread: 103376,23963231b5359f74 X-Google-Attributes: gid103376,public X-Google-Thread: 101deb,23963231b5359f74 X-Google-Attributes: gid101deb,public X-Google-Thread: 11440e,23963231b5359f74 X-Google-Attributes: gid11440e,public X-Google-ArrivalTime: 2001-06-07 20:10:53 PST Path: archiver1.google.com!newsfeed.google.com!sn-xit-02!sn-xit-01!supernews.com!newshub2.rdc1.sfba.home.com!news.home.com!news1.rdc1.bc.home.com.POSTED!not-for-mail From: Roedy Green 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 Organization: Canadian Mind Products Reply-To: roedy@mindprod.com Message-ID: <5sf0itoauh0fi1nvq4ll5ljmh3u4fjope1@4ax.com> References: <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> <3B202E17.7C728B66@brighton.ac.uk> X-Newsreader: Forte Agent 1.8/32.548 MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Date: Fri, 08 Jun 2001 03:10:53 GMT NNTP-Posting-Host: 24.76.128.193 X-Complaints-To: abuse@home.net X-Trace: news1.rdc1.bc.home.com 991969853 24.76.128.193 (Thu, 07 Jun 2001 20:10:53 PDT) NNTP-Posting-Date: Thu, 07 Jun 2001 20:10:53 PDT Xref: archiver1.google.com comp.lang.ruby:10471 comp.lang.ada:8379 comp.lang.awk:2877 comp.lang.clarion:21392 comp.lang.java.programmer:74597 comp.lang.pl1:883 comp.lang.vrml:3621 Date: 2001-06-08T03:10:53+00:00 List-Id: On Fri, 08 Jun 2001 02:44:55 +0100, John English wrote or quoted : >Hmm, I disagree. I'm not an American, so "zip plus 5" means absolutely >nothing to me (just like other American terms like GPA and K-12 and Bad example for an international audience. ZipPlus5 would be instantly familiar to any American bean counting programming team. For the purposes of discussion, (what to do in JavaDoc with methods and variables that don't desperately need a comment), you might come up with example methods that need no further elaboration, either because the vocabulary has a central project glossary definition or because there in nothing additional you have to say that is not obvious from the type information or the method/variable name. e.g. getSecondInitial getFaxAreaCode getSubscriptionExpiryDate setEstimatedArrivalTime For more detail, please look up the key words mentioned in this post in the Java Glossary at: http://mindprod.com/gloss.html If you don't see what you were looking for, complain! or send your contribution for the glossary. -- Roedy Green, Canadian Mind Products Custom computer programming since 1963. Ready to take on new work.