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,8b756d9a0afb052a
X-Google-Attributes: gid103376,public
X-Google-Language: ENGLISH,ASCII
Path: 
 g2news1.google.com!news3.google.com!news.glorb.com!newsfeed101.telia.com!nf02.dk.telia.net!news.tele.dk!news.tele.dk!small.news.tele.dk!proxad.net!fdn.fr!news.wanadoo.fr!news.wanadoo.fr!not-for-mail
Message-ID: <43FA0556.1090505@obry.net>
Date: Mon, 20 Feb 2006 19:07:18 +0100
From: Pascal Obry <pascal@obry.net>
Organization: Home - http://www.obry.net
User-Agent: Thunderbird 1.5 (Windows/20051201)
MIME-Version: 1.0
Newsgroups: comp.lang.ada
To: Brian May <bam@snoopy.apana.org.au>
Subject: Re: Quick question about Ada code formatting.
References: <Xns976E4AA3A7D3Cpchapinsovernet@198.186.192.137>
 <m2vevcpzlq.fsf@grendel.local>
 <Xns976EA58D4A4E4pchapinsovernet@198.186.192.137> <43F7915B.3090000@obry.net>
 <m2r760p5s7.fsf@grendel.local> <43F83D46.2090200@obry.net>
 <m2ek1zpt6s.fsf@grendel.local> <43F84890.7010900@obry.net>
 <43f871d8$0$491$9b4e6d93@newsread4.arcor-online.net>
 <43F872C4.50505@obry.net> <uek1znzo5.fsf@toadmail.com>
 <sa44q2upmik.fsf@snoopy.microcomaustralia.com.au>
In-Reply-To: <sa44q2upmik.fsf@snoopy.microcomaustralia.com.au>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 8bit
NNTP-Posting-Date: 20 Feb 2006 19:07:21 CET
NNTP-Posting-Host: 81.249.124.128
X-Trace: 1140458841 news.wanadoo.fr 18347 81.249.124.128:1815
X-Complaints-To: abuse@wanadoo.fr
Xref: g2news1.google.com comp.lang.ada:3015
Date: 2006-02-20T19:07:21+01:00
List-Id: <comp.lang.ada>

Brian May a �crit :

> However, the above is just asking for the comment to be expanded to
> clearly describe what on earth "Process_Whatever" does, and why it is
> different from the following procedures "Process_Whatever_2",
> "Princess_Whatever3", or "process_what_Ever_4".

I'm using a style where the spec must be declared. So the doc goes with
the spec (not with the body).

   procedure Process_Whatever;
   --  Do the right thing bla bla bla

On the body I comment about the implementation. This is also a good way
to separate the usage documentation on the spec and the technical one on
the body.

Pascal.

-- 

--|------------------------------------------------------
--| Pascal Obry                           Team-Ada Member
--| 45, rue Gabriel Peri - 78114 Magny Les Hameaux FRANCE
--|------------------------------------------------------
--|              http://www.obry.net
--| "The best way to travel is by means of imagination"
--|
--| gpg --keyserver wwwkeys.pgp.net --recv-key C1082595