|
Doc-O-Matic 10
|
   |
Alle ausblenden
Alle anzeigenWenn Ihr Sourcecode bereits dokumentiert ist, können Sie Doc-O-Matic an Ihre Art und Weise zu dokumentieren mit Hilfe der Settings anpassen. Beantworten Sie die in der Tabelle aufgelisteten Fragen und nehmen Sie die vorgeschlagenen Anpassungen vor. Wenn Ihre Antwort auf die Fragen in der Tabelle "Nein" lautet, sollte die Standardeinstellung für Ihre Art und Weise zu dokumentieren funktionieren. Wenn Ihre Antwort auf eine Frage "Ja" lautet, passen Sie Doc-O-Matic an Ihre Art und Weise Kommentare zu schreiben mit Hilfe der Settings an.
Um die Settings zu öffnen, klicken Sie auf der Symbolleiste für den Schnellzugriff auf Settings.
|
Ihre Art zu Dokumentieren |
Anpassen von Doc-O-Matic |
|
Verwenden Sie Javadoc-Tags, um Ihren Sourcecode zu dokumentieren? |
Sie können JavaDoc Unterstützung auf der Seite [General Settings] > Sections > Javadoc aktivieren. Weitere Informationen finden Sie in Verwenden von JavaDoc. |
|
Verwenden Sie \ als Beginnzeichen für Ihre Javadoc-Tags? |
Sie können die Unterstützung von \ auf der Seite [General Settings] > Sections > Javadoc aktivieren. |
|
Verwenden Sie C# XMLDoc-Tags, um Ihren Sourcecode zu dokumentieren? |
XMLDoc-Unterstützung ist in der Standardeinstellung aktiviert. Sie können die Standardeinstellung auf der Seite [General Settings] > Sections > XML ändern. Weitere Informationen finden Sie in Verwenden von XMLDoc. |
|
Schreiben Sie Ihre Kommentare in eine auf die Deklaration des Symbols folgende Zeile? |
Wählen Sie auf der Seite [General Settings] > Documentation > Comment Finding die Option Associate comment with previous symbol aus. In Auffinden von Kommentaren wird erklärt, wo genau Sie Ihre Kommentare bei einer Verwendung von Doc-O-Matic platzieren können. |
|
Verwenden Sie bestimmte Zeichen, um Dokumentationskommentare von anderen Kommentaren zu unterscheiden |
Geben Sie auf der Seite [General Settings] > Documentation > Comment Finding > Token Ihre Dokumentationszeichen ein. Die Token der Standardeinstellung sind @@. Die Einstellung Force token usage for code symbols führt dazu, dass Doc-O-Matic nur jene Kommentare extrahiert, die mit einem Dokumentationszeichen beginnen. Weitere Informationen über Token finden Sie in Dokumentationszeichen (Token). |
|
Verwenden Sie Tabellen, Tabellenkopfzeilen, Überschriften, Aufzählungszeichen, Walls, Trennzeichen für Parameterbeschreibungen und Abschlüsse? |
Doc-O-Matic unterstützt die verbreitetsten Zeichen, um diese Teile des Kommentars darzustellen. Um sicher zu stellen, dass Doc-O-Matic Ihre Art Kommentare zu formatieren versteht, geben Sie die Zeichen, die Sie verwenden im Dialogfeld Characters auf der Seite [General Settings] > Documentation > Comment Style ein. In Formatieren von Kommentaren finden Sie weitere Informationen. |
|
Unterteilen Sie Ihren Kommentarblock in verschiedene Abschnitte? (Zum Beispiel in Siehe auch, Remarks und Parameterbeschreibungen) |
Wie Sie Doc-O-Matic an Ihre Art und Weise den Kommentarblock zu unterteilen anpassen können, beschreibt Anpassen von Abschnitten. |
|
Verwenden Sie Trennzeichen, um die Anfangszeichen eines Abschnittes und den Abschnittstext voneinander zu trennen? |
Wie Sie Doc-O-Matic dazu bringen Ihre Trennzeichen zu erkennen, beschreibtAnpassen von Abschnitten. |
|
Verwenden Sie für die Beschreibung von Parametern die gesamte Parameterbeschreibung oder nur den Namen des Parameters? |
Die Standardeinstellung von Doc-O-Matic für Parameterbeschreibungen ist "simple". Auf der Seite [General Settings] > Documentation > Comment Style > Parameters können Sie andere Optionen auswählen. |
Für fortgeschrittene BenutzerDoc-O-Matic kann noch weiter an Ihre Art und Weise zu dokumentieren angepasst werden. Sie können
Siehe auchVerwandte EinstellungenJavadoc, XML, Kommentare finden, Dokumentationszeichen, Kommentarstil, Parameter
    |