A Flexible and Efficient Annotation Approach based on XML

Dies ist ein unbeendeter Bericht über den Einsatz des AST/TA Ansatzes im praktischen Rahmen. Verwendet wurde dabei das xml/g Tool auf Quelltexte des PFE Forth zur automatischen Erzeugung von Dokumentation ähnlich javadoc / doxygen.

Das besondere hier ist, dass keine spezielle interne Datenstruktur nötig ist, sondern die AST/TA Speicherung eines XML Dokumentes verwendet wird. Man kann in jedem Analyseschritt / Aufbereitungsschritt der Dokumentations synthese dieses interne XML Dokument auf Platte speichern zur Untersuchung oder Zwischenverarbeitung mit anderen Werkzeugen.

In diesem Fall ist der ursprüngliche Quelltext auch der Textinhalt des TextArray des initialen XML-Dokuments. Das initiale XML-Dokument enthält nur einen Knoten, der auf den Anfang und das Ende des Textblocks verweist. Das resultierende Analyse XML-File (nach vielen Schritten) enthält viele Markups, und wird mit noch mit Attributen in den Markups gefüllt, die Querreferenzen auf innere und äussere Informationen anbieten. Anschliessend können allein mit diesen Markups (und meist mit simplen xpath-selects) Teile herausgefiltert werden und separat abgelegt werden, z.B. die Liste exportierter Funktionen und ihren sehr verschiedenen Deklarationsvarianten.

Der Bericht vergleicht die AST/TA Implementation mit bereits bestehenden Verfahren, die sourcecode eingebetteten Dokumentationen verarbeiten können. Die Vergleichbarkeit konnte aber nie sichergestellt werden, sodass die beschriebenen "Ergebnisse" nicht als fundiert angesehen werden dürfen, obwohl sie plausibel sind und die realen Messdaten den Verdacht stützen. In jedem Falle ist der AST/TA sehr flexibel ohne merklich an Effizienz einzubüssen.