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!news1.google.com!news3.google.com!news.glorb.com!news.newsland.it!proxad.net!193.252.118.146.MISMATCH!news.wanadoo.fr!news.wanadoo.fr!not-for-mail
Message-ID: <43F8CE76.3040602@obry.net>
Date: Sun, 19 Feb 2006 21:00:54 +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: "Jeffrey R. Carter" <spam@spam.com>
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>
 <OC3Kf.3064$UN.2910@newsread2.news.pas.earthlink.net>
In-Reply-To: <OC3Kf.3064$UN.2910@newsread2.news.pas.earthlink.net>
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 8bit
NNTP-Posting-Date: 19 Feb 2006 21:00:57 CET
NNTP-Posting-Host: 82.120.29.165
X-Trace: 1140379257 news.wanadoo.fr 20144 82.120.29.165:1360
X-Complaints-To: abuse@wanadoo.fr
Xref: g2news1.google.com comp.lang.ada:2997
Date: 2006-02-19T21:00:57+01:00
List-Id: <comp.lang.ada>

Jeffrey R. Carter a �crit :
> Pascal Obry wrote:
> 
>> Between subprograms I prefer the "GNAT style" header box:
>>
>>   ----------------------
>>   -- Process_Whatever --
>>   ----------------------
>>
>>   procedure Process_Whatever is
> 
> Comments should add value; these blocks add nothing. You can tell it's
> Process_Whatever from the next non-comment, non-blank line. This is
> about as useful as
> 
> -- Add 1 to X
> X := X + 1;

I just do not agree, it helps a lot browsing and looking for a specific
routine in a source file. It is not a really comment certainly not
something you can compare with "Add 1 to X" ! It is a kind of separator
that clearly stand out. BTW, this is the GNAT style, a style that I use
for AWS... But again this is just one style.

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