From: Pascal Obry <pascal@obry.net>
To: "Jeffrey R. Carter" <spam@spam.com>
Subject: Re: Quick question about Ada code formatting.
Date: Sun, 19 Feb 2006 21:00:54 +0100
Date: 2006-02-19T21:00:57+01:00 [thread overview]
Message-ID: <43F8CE76.3040602@obry.net> (raw)
In-Reply-To: <OC3Kf.3064$UN.2910@newsread2.news.pas.earthlink.net>
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
next prev parent reply other threads:[~2006-02-19 20:00 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2006-02-18 12:19 Quick question about Ada code formatting Peter C. Chapin
2006-02-18 13:00 ` Ludovic Brenta
2006-02-18 13:26 ` Simon Wright
2006-02-18 15:36 ` Georg Bauhaus
2006-02-18 16:52 ` Georg Bauhaus
2006-02-19 0:27 ` Simon Wright
2006-02-19 4:17 ` Jeffrey R. Carter
2006-02-19 9:51 ` Simon Wright
2006-02-19 15:23 ` Stephen Leake
2006-02-19 22:32 ` Simon Wright
2006-02-19 12:23 ` Georg Bauhaus
2006-02-19 22:23 ` Simon Wright
2006-02-22 22:15 ` Stephen Leake
2006-02-22 23:13 ` Georg Bauhaus
2006-02-23 12:50 ` Stephen Leake
2006-02-23 15:40 ` Jean-Pierre Rosen
2006-02-18 19:16 ` Pascal Obry
2006-02-18 21:16 ` Peter C. Chapin
2006-02-18 21:27 ` Pascal Obry
2006-02-19 0:10 ` Simon Wright
2006-02-19 9:41 ` Pascal Obry
2006-02-19 9:57 ` Simon Wright
2006-02-19 10:29 ` Pascal Obry
2006-02-19 12:31 ` Georg Bauhaus
2006-02-19 13:29 ` Pascal Obry
2006-02-19 15:20 ` Stephen Leake
2006-02-20 6:33 ` Brian May
2006-02-20 18:07 ` Pascal Obry
2006-02-22 22:21 ` Stephen Leake
2006-02-20 8:17 ` Lionel Draghi
2006-02-20 19:07 ` Martin Krischik
2006-02-22 22:30 ` Stephen Leake
2006-02-22 22:39 ` Pascal Obry
2006-02-23 12:56 ` Stephen Leake
2006-02-23 15:02 ` Martin Krischik
2006-02-24 10:13 ` Stephen Leake
2006-02-24 19:02 ` Martin Krischik
2006-02-24 23:29 ` Georg Bauhaus
2006-02-20 18:52 ` Pascal Obry
2006-02-21 8:07 ` Alex R. Mosteo
2006-02-22 22:32 ` Stephen Leake
2006-02-23 6:02 ` Jeffrey R. Carter
2006-02-23 12:58 ` Stephen Leake
2006-02-19 19:25 ` Jeffrey R. Carter
2006-02-19 20:00 ` Pascal Obry [this message]
2006-02-19 22:27 ` Simon Wright
2006-02-20 4:32 ` Jeffrey R. Carter
2006-02-20 22:10 ` Randy Brukardt
2006-02-22 22:36 ` Stephen Leake
2006-02-23 9:49 ` Alex R. Mosteo
2006-02-23 12:42 ` Jean-Pierre Rosen
2006-02-24 10:15 ` Stephen Leake
2006-02-20 7:11 ` Jean-Pierre Rosen
2006-02-21 21:23 ` Simon Wright
2006-02-19 15:17 ` Stephen Leake
2006-02-18 14:43 ` Martin Krischik
2006-02-18 20:21 ` Jeffrey R. Carter
2006-02-19 10:02 ` Dmitry A. Kazakov
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox