TEAM-ADA Archives

Team Ada: Ada Programming Language Advocacy

TEAM-ADA@LISTSERV.ACM.ORG

Options: Use Forum View

Use Monospaced Font
Show Text Part by Default
Show All Mail Headers

Message: [<< First] [< Prev] [Next >] [Last >>]
Topic: [<< First] [< Prev] [Next >] [Last >>]
Author: [<< First] [< Prev] [Next >] [Last >>]

Print Reply
Subject:
From:
Rich Hilliard <[log in to unmask]>
Reply To:
Date:
Tue, 21 Jul 1998 22:30:24 -0400
Content-Type:
text/plain
Parts/Attachments:
text/plain (56 lines)
> > They were:  --|
>
> I believe this is based on an IEEE spec.  Anyone familiar with it?
> Can't find my own notes on it.

Now we're really digging into Ada trivia!

As I recall, Anna had two types of structured comments:

--: virtual Ada

--| annotations

Annotations were the things you want to express about the
program (invariants, pre-, post conditions, etc.). Virtual
Ada was the 'scaffolding' you needed to write to give the
annotations an operational interpretation (over and above
the code itself you were annotating.)

IEEE 990-1987, Recommended Practice for Ada as a Program
Design Language, recommended that "structured comments" be
"identified by a sentinel character, word or phrase
immediately following the double dash that indicates a
comment to an Ada compiler ..." -- but it did not prescribe
a particular sentinel.

 -- Rich Hilliard



Terry Westley wrote:
>
> On Tuesday, July 21, 1998 2:30 AM, Erik Margraf [SMTP:[log in to unmask]] wrote:
> > [log in to unmask] wrote:
> >
> > > >I think Ada should have something like this, may be we can choose a
> > > >different tag than "@", but the IDEA of javadoc is good, you can argue
> > > >on implementation.
> > >
> > > it would be best if we could have a meta language/registry for languages
> > > embedded in comments, so that we don't have clashes b/w various options.
> > > E.g. do you know what the lead in characters for an ANNA annotation are?
> > >
> > > Dale
> >
> > They were:  --|
>
> I believe this is based on an IEEE spec.  Anyone familiar with it?
> Can't find my own notes on it.
>
> --
> Terry J. Westley, Principal Engineer
> Calspan, An operation of Veridian
> P.O. Box 400, Buffalo, NY 14225
> [log in to unmask]    http://www.calspan.com

ATOM RSS1 RSS2