From: Stephen Leake <stephe_on_the_web@toadmail.com>
Subject: Re: Quick question about Ada code formatting.
Date: Wed, 22 Feb 2006 17:36:11 -0500
Date: 2006-02-22T17:36:11-05:00 [thread overview]
Message-ID: <uoe0zvx5w.fsf@toadmail.com> (raw)
In-Reply-To: zImdnfZp4LezoGfenZ2dnUVZ_vydnZ2d@megapath.net
"Randy Brukardt" <randy@rrsoftware.com> writes:
> "Pascal Obry" <pascal@obry.net> wrote in message
> news:43F872C4.50505@obry.net...
>> Georg Bauhaus a �crit :
>>
>> > They can indicate a major block. For example in Matt's AI 302
>> > implementation, there are blank lines between many executable
>> > statements. There are two blank lines between most, if not all,
>> > subprograms.
>>
>> Between subprograms I prefer the "GNAT style" header box:
>>
>> ----------------------
>> -- Process_Whatever --
>> ----------------------
>>
>> procedure Process_Whatever is
>> ...
>>
>> Far clearer than 2 blank lines IMHO.
>
> But extremely hard to maintain. We used a style like that in the Janus/Ada
> compiler, and we found that we were spending a lot of time lining up the
> closing hyphens ever time the comment changed in some way.
Yes. One of the projects I'm on (GWindows) also requires this style.
After the first couple of days, I wrote an Emacs macro to write the
comment for me.
Customizable tools are essential.
Just out of curiosity; has any GPS user out there written a macro like
that for GPS? In general, how easy is it to write macros for GPS?
> After all, the idea isn't to carry any information, but to simply to
> separate the procedures. (Comments that repeat what is obviously known by
> reading the source code are evil, IMHO, so I find this comment wasteful.)
> Perhaps a better approach would be to include a dashed line separator
> between procedures -- but that takes *three* lines, and since you never have
> enough screen real estate, so it seems like a waste.
Right on :).
--
-- Stephe
next prev parent reply other threads:[~2006-02-22 22:36 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
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 [this message]
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