#286 Better doc-comments
From
http://www.eros-os.org/pipermail/e-lang/2005-August/010986.html
Right now, we have only unstructured text. I think
there should be a
means of including richer documentation formats: either
allowing
restricted (DeepPassByCopy, maybe more) data for
documentation (where
anything that doesn't know how to use the particular
value does
E.toString() on it), or a *well-specified* markup
language; XML might
work, since it has namespaces.
(Also, though this is not a Kernel-E issue, I would
like to see the
parser changed so that incidental aspects of the
in-source syntax for
documentation don't show up in the source. For example,
right now, /**
foo */ parses to " foo ". This is particularly bad with
multi-line
comments. We may have inherited the Javadoc surface
syntax, but let's
not get stuck with any of its quirks. (I also think the
left-column-of-asterisks structure should be dropped as
far too
heavyweight, but that's a separate issue.))
