From: Pascal Obry <pascal@obry.net>
To: Brian May <bam@snoopy.apana.org.au>
Subject: Re: Quick question about Ada code formatting.
Date: Mon, 20 Feb 2006 19:07:18 +0100
Date: 2006-02-20T19:07:21+01:00 [thread overview]
Message-ID: <43FA0556.1090505@obry.net> (raw)
In-Reply-To: <sa44q2upmik.fsf@snoopy.microcomaustralia.com.au>
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
next prev parent reply other threads:[~2006-02-20 18:07 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 [this message]
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
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