comp.lang.ada
 help / color / mirror / Atom feed
From: Brian Rogoff <bpr@shell5.ba.best.com>
Subject: Re: javadoc => adadoc?
Date: 1998/08/04
Date: 1998-08-04T00:00:00+00:00	[thread overview]
Message-ID: <Pine.BSF.3.96.980804092449.11315B-100000@shell5.ba.best.com> (raw)
In-Reply-To: 6q7773$mhi$1@mdnews.btv.ibm.com

On Tue, 4 Aug 1998, Norman H. Cohen wrote:
... snip ...
> To summarize, javadoc is a handy tool which can provide effective
> component-user documentation when used in a conscientiously applied program
> of thorough commentary.  It does not produce design documentation, and it
> does not produce decent user documentation without human effort.  Ada would
> benefit from a similar tool.  (Wasn't a grad student at GWU working on one a
> couple of years ago?)

My own experience with the Java tools confirms this. If anything I found
that the psychological effect was the opposite of what was described;
programmers spent more time carefully documenting the code and keeping the 
user level documentation up to date with the javadoc tool. 

There are a few other tools which would be nice in an Ada environment,
like an Ada version of LCLint from the Larch toolkit (*), or a more 
general version of the SPARK analysis tools.

-- Brian

(*) http://www.sds.lcs.mit.edu/spd/larch/index.html





  reply	other threads:[~1998-08-04  0:00 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
1998-07-31  0:00 javadoc => adadoc? nelson
1998-08-01  0:00 ` Matthew Heaney
1998-08-01  0:00 ` nabbasi
1998-08-03  0:00   ` Norman H. Cohen
1998-08-03  0:00     ` Charles Hixson
1998-08-04  0:00       ` Robert Dewar
1998-08-04  0:00         ` Larry Kilgallen
1998-08-04  0:00           ` Norman H. Cohen
1998-08-04  0:00             ` Brian Rogoff [this message]
1998-08-04  0:00               ` Charles Hixson
1998-08-17  0:00                 ` Peter Hermann
1998-08-17  0:00                   ` Corey Minyard
1998-08-18  0:00                     ` Charles Hixson
1998-08-19  0:00                       ` Samuel Tardieu
1998-08-26  0:00                     ` Simon Wright
replies disabled

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