Friday, August 27, 2004

QVTdoc

In the same way as Javadoc (putting specificly formatted comments in the right places) currently provides a way of creating online library manuals for Java classes, we need a way of using comments in Transformation specifications (QVT concrete syntax) to create a friendly formatted transformation description. I think LaTeX may be the way to go... it would be easy to put a \begin{verbatim} before the beginning of the plain text for a transformation, and then substitute wrap any QVTdoc comments in a \end{verbatim} / \begin{verbatim} pair, so that the plain text of the comments is made more readable... and any embedded LaTeX in the comments is then used directly.

0 Comments:

Post a Comment

<< Home