Sie sind hier: Weitere Informationen > Spezielle Aufgaben
Spezielle Aufgaben
Technische Referenz
> Anpassen von Doc-O-Matic > Anpassen von Abschnitten
Anpassen von Abschnitten
Close
Doc-O-Matic 10
Anpassen von Abschnitten

Üblicherweise sind Kommentarblöcke in verschiedene logische Bereiche unterteilt. Diese Teile beginnen meistens mit einer Überschrift gefolgt von Text, entweder auf der gleichen Zeile oder der nächsten Zeile. In Doc-O-Matic heißen diese Bereiche Abschnitte. Wenn Sie Doc-O-Matic verwenden ist es nicht notwendig, dass Sie die Beginnzeichen von Abschnitten oder deren Überschriften in bestimmter Weise erkennbar machen. Text der auf Beginnzeichen folgt, muss lediglich auf der nächsten Zeile beginnen oder durch ein Trennzeichen vom Beginnzeichen getrennt sein

  1. Stellen Sie sicher, dass XMLDoc-Support aktiviert ist, wenn Sie C# XML-Kommentare verwenden und Javadoc-Support, wenn Sie Javadoc verwenden und \ Unterstützung wenn Sie \ Zeichen als Beginnzeichen für Javadoc-Tags verwenden. Doc-O-Matic erkennt die Abschnittsbeginnzeichen in XMLDoc und Javadoc.
  2. Erstellen Sie einen neuen Abschnitt für jeden Abschnitt den Doc-O-Matic nicht erkennt.
  3. Wählen Sie einen bestehenden Abschnitt aus der Abschnittsliste auf der Seite [General Settings] > Sections aus, wenn Sie möchten dass Ihr Abschnitt als einer der vordefinierten Abschnitte dargestellt wird. Fügen Sie zu diesem Abschnitt Ihre Beginnzeichen in Starters hinzu oder geben Sie im Dialog Abschnitt bearbeiten Dialog die Javadoc-Tags in Javadoc oder die XMLDoc-Tags in XMLDoc ein.
  4. Stellen Sie sicher, dass die Abschnittstrennzeichen, die Sie verwenden erkannt werden, es sei denn Sie beginnen den Abschnittstext in einer eigenen Zeile. Wenn Sie Leerzeichen als Abschnittstrennzeichen verwenden aktivieren Sie das Kontrollkästchen Allow spaces as section delimiters und Allow spaces as delimiters for parameter names auf der Seite [General Settings] > Sections > Delimiters.

Doc-O-Matic ist in der Lage automatisch eine Zusammenfassung (Summary) von Ihren Kommentaren zu erzeugen. Weitere Informationen finden Sie in Automatischer Abschnitt.

Javadoc, XML, Trennzeichen, Automatischen Abschnitte, Abschnitte

Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.