Dokumentationsgenerierung mit Delphi 2006

[Martin99]

Habe eine Möglichkeit gefunden
Hier zur Dokumentation, falls jemand anderes dieses Problem auch hat:

• 1. Auf der Diagrammsicht mit der rechten Maustaste auf das Element klicken, dem eine Beschreibung hinzugefügt werden soll
• 2. Auswählen "Einschränkungen..." zur Definition von Bedingungen für den Aufruf oder "Benutzereigenschaften..." zur Definition von sonstigen Beschreibungen
• 3. Auf der erscheinenden Maske "Hinzufügen" klicken
• 4. Einen Namen für das zu beschreibende Element eingeben (z.B. "Description" oder "Parameter 1" oder "Returnwert").
• 5. Die Beschreibung eingeben. Über den Button mit den drei Punkten kann auch eine mehrzeilige Beschreibung eingegeben werden.

Die Punkte 3 bis 5 können mehrfach wiederholt werden. Bedingung: der gleiche Name darf nur einmal vorkommen. Man kann also nicht, wie z.B. in JavaDoc, mehrere "@param" Einträge hintereinander machen.

Die eingegebenen Beschreibungen werden vorerst einmal vor der Deklaration des ausgewählten Elements in den Code eingefügt. Beispiel:

Delphi-Quellcode:

    ///<desc>Einen Phrase erstellen
    ///Als Input wird die ID des Phrases benötigt. Der Phrase muss also schon einmal identifiziert worden sein.
    ///Vorgehen: 1. IdentifyWords
    ///2. (mit den identifizierten Wörtern) FindPhrases
    ///3. (mit dem ausgewähltem Phrase) CreatePhrase</desc>
    ///  <paramater1>PhrID = ID des neuen Phrases</paramater1>
    ///  <mod__constraintReferencedElement>design:node:::85ix7n07m_n</mod__constraintReferencedElement>
    ///  <returnwert>Phrase als Interface ITBLPhrase</returnwert>
    function CreatePhrase(PhrID: Integer): ITBLPhrase;

Das obige Beispiel erscheint dann so in der Dokumentation:
...
1:Einschränkung 1
PhrID > 0
Constraint language
OCL
...
desc
Einen Phrase erstellen
Als Input wird die ID des Phrases benötigt. Der Phrase muss also schon einmal identifiziert worden sein.
Vorgehen: 1. IdentifyWords
2. (mit den identifizierten Wörtern) FindPhrases
3. (mit dem ausgewähltem Phrase) CreatePhrase
parameter1
PhrID = ID des neuen Phrases
returnwert
Phrase als Interface ITBLPhrase