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.9 required=5.0 tests=BAYES_00 autolearn=ham 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: 107a89,23963231b5359f74 X-Google-Attributes: gid107a89,public X-Google-Thread: 101deb,23963231b5359f74 X-Google-Attributes: gid101deb,public X-Google-Thread: 11440e,23963231b5359f74 X-Google-Attributes: gid11440e,public X-Google-Thread: 103376,23963231b5359f74 X-Google-Attributes: gid103376,public X-Google-Thread: 10a146,23963231b5359f74 X-Google-Attributes: gid10a146,public X-Google-Thread: 1073c2,23963231b5359f74 X-Google-Attributes: gid1073c2,public X-Google-ArrivalTime: 2001-06-08 07:22:49 PST Path: archiver1.google.com!newsfeed.google.com!sn-xit-02!supernews.com!nntp-relay.ihug.net!ihug.co.nz!news-spur1.maxwell.syr.edu!news.maxwell.syr.edu!newsfeed.cwix.com!sjc-peer.news.verio.net!news.verio.net!iad-read.news.verio.net.POSTED!not-for-mail Newsgroups: comp.lang.ruby,comp.lang.ada,comp.lang.awk,comp.lang.clarion,comp.lang.java.programmer,comp.lang.pl1,comp.lang.vrml 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> From: "Shmuel (Seymour J.) Metz" Subject: Re: Commenting code Mail-Copies-To: nobody Organization: Atid/2 X-Cise: "Tony Schliesser" X-CompuServe-Customer: Yes X-Coriate: NCAE@NewAmerica.org X-Ecrate: Bob Germer X-Punge: Micro$oft X-Sanguinate: themvsguy@email.com X-Terminate: SPA(GIS) Message-ID: <3b20d633$8$fuzhry$mr2ice@va.news.verio.net> X-Newsreader: MR/2 Internet Cruiser Edition for OS/2 v2.28a/28 Date: Fri, 08 Jun 2001 09:42:11 -0400 NNTP-Posting-Host: 206.55.10.86 X-Complaints-To: abuse@verio.net X-Trace: iad-read.news.verio.net 992010169 206.55.10.86 (Fri, 08 Jun 2001 14:22:49 GMT) NNTP-Posting-Date: Fri, 08 Jun 2001 14:22:49 GMT Xref: archiver1.google.com comp.lang.ruby:10491 comp.lang.ada:8412 comp.lang.awk:2904 comp.lang.clarion:21445 comp.lang.java.programmer:74766 comp.lang.pl1:910 comp.lang.vrml:3647 Date: 2001-06-08T09:42:11-04:00 List-Id: In , on 06/07/2001 at 09:58 PM, Roedy Green said: >Assembler commenting requires that you be able to follow the logic >without looking at ANY of the code. No way! That just obscurs the code and makes it less likely that errors will be spotted. >Without a complete picture of what >is going on in the comments, it is very difficult to find the code >you are looking for. Au contraire; with a complete picture you can't see the forrest for the trees. Comments should explain the code, not echo it. Some authors have gone so far as to insist on covering the comments while reviewing the code to ensure that the reviewer is not mislead by the comments. -- ----------------------------------------------------------- Shmuel (Seymour J.) Metz, SysProg and JOAT Atid/2 Team OS/2 Team PL/I Any unsolicited commercial junk E-mail will be subject to legal action. I reserve the right to publicly post or ridicule any abusive E-mail. I mangled my E-mail address to foil automated spammers; reply to domain acm dot org user shmuel to contact me. Do not reply to spamtrap@library.lspace.org -----------------------------------------------------------