Javadoc verwenden

Javadoc ist ein weit verbreiteter Dokumentationsstandard. Wenn Sie Ihren Sourcecode in Übereinstimmung mit dem Javadoc-Standard dokumentieren, ist es sehr einfach Doc-O-Matic anzupassen. Weitere Informationen darüber, wo Sie Ihre Kommentare platzieren können finden Sie in Anpassen von Doc-O-Matic.

Javadoc-Tags

Um Kommentare zu strukturieren, unterstützt Javadoc spezielle Tags (zum Beispiel @param). Doc-O-Matic unterstützt die meisten standard Javadoc-Tags. Doc-O-Matic unterstützt auch viele Javadoc-Tags, die von anderen Dokumentationswerkzeugen wie zum Beispiel Doxygen verwendet werden, die aber keine Standard-Tags sind. Behandeln von Javadoc beschreibt, wie Doc-O-Matic standard und nicht-standard Javadoc-Tags behandelt.

Um Javadoc-Tags einzufügen

Doc-O-Matic ist in der Lage Javadoc-Tags (entweder @ oder \ als Beginnzeichen) 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 JavaDoc ausgewählt haben, wandelt Doc-O-Matic Ihre Kommentare in Text und Standard Javadoc-Tags um.
Wenn Sie vordefinierte Abschnitte verwenden, stellen Sie bitte sicher, dass die Javadoc-Tags, die Sie in den Sourcecode einfügen möchten, als erstes Beginnzeichen in JavaDoc im Dialog Edit Section aufgelistet sind.
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 Javadoc-Tags können nur in analysierbaren Sourcecodedateien und nicht in DTX-Dateien eingefügt werden.

Verfügbar in: Doc-O-Matic Professional