This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: "Alexandre E. Kopilovitch" <aek at VB1162 dot spb dot edu>
- To: Joe Buck <Joe dot Buck at synopsys dot COM>, Robert Dewar <dewar at gnat dot com>
- Cc: Andrew Sutton <asutton at cs dot kent dot edu>, gcc at gcc dot gnu dot org, Jamie Lokier <jamie at shareable dot org>, Richard Kenner <kenner at vlsi1 dot ultra dot nyu dot edu>, law at redhat dot com
- Date: Mon, 2 Feb 2004 21:51:33 +0300 (MSK)
- Subject: Re: "Documentation by paper"
- References: <20040202085911.A2108@synopsys.com>
On Mon, 2 Feb 2004 08:59:11 -0800, Joe Buck wrote:
> Robert, the Ada interface description is far from a spec, for any
> nontrivial function. Almost any real spec will describe restrictions
> on input, and guarantees about the output, that are not written
> in a form that the compiler parses (even in languages like Eiffel with
> support for preconditions and postconditions). This means that we
> are back to comments.
Yes, but these comments are localized inside the specs, so for documentation
purposes there isn't too much difference between them and actual code (except
that a comment may be plain wrong -:) .