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-Thread: 103376,81054609038e88e3 X-Google-Attributes: gid103376,public X-Google-Language: ENGLISH,ASCII Path: g2news1.google.com!news2.google.com!proxad.net!news.tele.dk!news.tele.dk!small.news.tele.dk!news-stoc.telia.net!telia.net!217.209.241.158.MISMATCH!newspeer1.se.telia.net!se.telia.net!masternews.telia.net.!newsc.telia.net.POSTED!not-for-mail From: =?ISO-8859-1?Q?Bj=F6rn_Persson?= User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.4.1) Gecko/20031114 X-Accept-Language: sv, sv-se, sv-fi, en-gb, en-us, en MIME-Version: 1.0 Newsgroups: comp.lang.ada Subject: Re: Literate Programming in Ada, AdaDoc, AdaBrowse References: <2sqmccF1oit5sU1@uni-berlin.de> <4168e585.146011813@news.free.fr> In-Reply-To: <4168e585.146011813@news.free.fr> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: quoted-printable Message-ID: Date: Mon, 11 Oct 2004 23:02:55 GMT NNTP-Posting-Host: 217.209.116.179 X-Complaints-To: abuse@telia.com X-Trace: newsc.telia.net 1097535775 217.209.116.179 (Tue, 12 Oct 2004 01:02:55 CEST) NNTP-Posting-Date: Tue, 12 Oct 2004 01:02:55 CEST Organization: Telia Internet Xref: g2news1.google.com comp.lang.ada:5058 Date: 2004-10-11T23:02:55+00:00 List-Id: Stephane Riviere wrote: > just put your text before the > procedure, function, etc...to comment... Does AdaDoc require that the description be before the declaration, or=20 can it be after too? I find it more natural to put it after, like this: function Synonym (Reference : Parameter_Name) return Parameter_Definition_Handle; -- Returns a definition which states that the parameter is -- an alternative name for another parameter. function Antonym (Reference : Parameter_Name; Description : EAstring :=3D Null_EAstring) return Parameter_Definition_Handle; -- Returns a definition which states that the parameter is -- the opposite of another parameter. It can only be used -- on boolean parameters. Illegal_Antonym : exception; -- A parameter is defined as an antonym of a parameter that -- can't have antonyms. (Only boolean parameters can have -- antonyms.) This tells you first of all what is being declared (function, type,=20 variable ...) and what its name is. Then it's explained what it does,=20 and if parameter names are mentioned in the description, then they have=20 been declared before they're referenced, just like in the code. In my opinion, writing the description before the declaration breaks the = text flow in about the same way as top-posting does. --=20 Bj=F6rn Persson PGP key A88682FD omb jor ers @sv ge. r o.b n.p son eri nu