XMLDoc verwenden

XMLDoc ist ein neuer Dokumentationsstandard der in C# verwendet wird. Wenn Sie Ihren Sourcecode mit XMLDoc-Tags dokumentieren ist es sehr einfach Doc-O-Matic anzupassen. Weitere Informationen hierzu finden Sie in Anpassen von Doc-O-Matic.

XMLDoc-Tags

XMLDoc-Tags werden verwendet, um den Kommentar zu strukturieren und zu formatieren. Es gibt einige Tags, die allgemein anerkannte Funktionen in eine Dokumentation haben. Wenn die Unterstützung für XML aktiviert ist, unterstützt Doc-O-Matic die verbreitetsten XMLDoc-Tags. Die meisten Tags werden als Doc-O-Matic Abschnitt interpretiert. Behandeln von XMLDoc-Tags beschreibt, wie Doc-O-Matic die XMLDoc-Tags seinen Abschnitten und Formatierungen zuweist.

Einfügen von XMLDoc-Tags

Doc-O-Matic ist in der Lage XMLDoc-Tags in Ihren Sourcecode einzufügen, wenn Sie die Kommentare im Editor bearbeiten.
Die Option Dokumentationsstandard ermöglicht es Ihnen anzugeben, welchen Standard Sie beim Einfügen der Kommentare in den Sourcecode verwenden möchten.
Wenn Sie die Option XMLDoc ausgewählt haben, wandelt Doc-O-Matic Ihre Kommentare in Text und XMLDoc-Tags um.
Wenn Sie vordefinierte Abschnitte verwenden, stellen Sie bitte sicher, dass derjenige XMLDoc-Tag, den Sie in den Sourcecode einfügen möchten, als erstes Beginnzeichen in XMLDoc im Dialog Edit Section aufgelistet ist.
In Zurückschreiben von Kommentaren erfahren Sie mehr darüber, wie Doc-O-Matic die im Editor geschriebenen Kommentare zurück in den Sourcecode schreibt. Editions XMLDoc-Tags können nur in analysierbare Sourcecodedateien und nicht in DTX-Dateien eingefügt werden.

Verfügbar in: Doc-O-Matic Professional