comp.lang.ada
 help / color / mirror / Atom feed
From: Sébastien <seb.morand@gmail.com>
Subject: Re: Access procedure to pointer
Date: Mon, 02 Jun 2008 12:24:49 +0000
Date: 2008-06-02T12:24:49+00:00	[thread overview]
Message-ID: <g20oqm$slv$1@registered.motzarella.org> (raw)
In-Reply-To: 

> You could read the .ads files. They are well written and concise. I
> don't see what other form of documentation would be much better. 

I can and I do, but just because I don't have any choice. Of course Ada 
is easy to read, but there is no hyperlink navigation, this is quite 
boring. For instance you find out a function, let's say the 
documentation is clear, yes but ada is strongly typed and then have a 
lot of new type in order to assure safety and quality of the code. So 
you have then to find the definition of the type and so on...

Documentation is the most important part of any technology. Even if Ada 
code is well documented, a user friendly version of the documentation 
easy to read and to navigate will be a better way to promote the 
language and help new developer. If your technology is reliable, well 
designed but with no documentation, don't even try to promote it in 
professional world, it will be a waste of time.

> You mention javadoc in another post. That's just a massaged form of
> comments and code from java source code. In java, that makes sense,
> because there is no separation of interface from implementation (no
> analogy of .ads vs .adb). So reading the java source files is tedious
> and confusing, if all you want is a list of functions you could call.
> 
> For Ada, that's simply not necessary; .ads files serve the same
> purpose, without needing a separate tool. 

I completly disagree, even if ada source code is far easier to read than 
any other language. See remarks above.

Moreover, a document should hide the implementation detail in order to 
be clearer and more concise. In ada, ads and adb are often in the same 
directory in all installation I tried, so it's not really helping.

Moreover no documentation means no index or any stuff like that, no 
search form to find all the files that could be usefull for you. At 
least, the name of the file in ada distribution are not really 
meaningful, s-interr.ads does not mean anything to me.




  reply	other threads:[~2008-06-02 12:24 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-05-27 11:19 Access procedure to pointer Sébastien
2008-05-27 12:05 ` Ludovic Brenta
2008-05-27 17:45   ` Sébastien
2008-05-27 18:26     ` Dmitry A. Kazakov
2008-05-28  9:06       ` Sébastien
2008-05-28 10:13         ` Jean-Pierre Rosen
2008-05-28 14:57           ` Sébastien
2008-05-28 15:26             ` Jean-Pierre Rosen
2008-05-28 18:16               ` Jeffrey R. Carter
2008-05-28 18:30                 ` Robert A Duff
2008-05-28 21:36               ` Adam Beneschan
2008-05-28 23:02                 ` Sebastien Morand
2008-05-29  0:58                   ` Jeffrey R. Carter
2008-05-29  9:06                     ` Sébastien
2008-05-29 20:20                       ` Jeffrey R. Carter
2008-05-29  8:43                   ` Jean-Pierre Rosen
2008-05-29 10:18                     ` Sébastien
2008-05-29 11:34                       ` Jean-Pierre Rosen
2008-05-31  5:52                   ` Stephen Leake
2008-06-02 12:24                     ` Sébastien [this message]
2008-06-02 12:55                       ` Georg Bauhaus
2008-06-02 18:19                       ` Jeffrey R. Carter
2008-06-02 18:25                         ` Pascal Obry
2008-06-03 10:06                         ` Sébastien Morand
2008-06-03 13:26                           ` Ed Falis
2008-06-03 19:41                       ` Stephen Leake
2008-06-02 15:35                     ` Adam Beneschan
2008-06-02 17:11                       ` Jean-Pierre Rosen
2008-06-03 19:43                       ` Stephen Leake
2008-05-28 15:29             ` Sébastien
2008-05-28 17:00           ` Simon Wright
2008-05-27 20:06     ` Jeffrey R. Carter
2008-05-27 22:27     ` Adam Beneschan
2008-05-27 16:51 ` Jeffrey R. Carter
2008-05-27 17:42   ` Sébastien
2008-05-27 20:02     ` Jeffrey R. Carter
2008-05-27 20:45     ` Jacob Sparre Andersen
2008-05-28  8:48       ` Sébastien
2008-05-28 20:41         ` Jacob Sparre Andersen
replies disabled

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox