Sie sind hier: AutoDoc und Formatieren > AutoDoc-Teile anpassen > Verändern der Darstellung des Sourcecodes
Close
Doc-O-Matic 10
Verändern der Darstellung des Sourcecodes

Doc-O-Matic stellt verschiedene Möglichkeiten zur Verfügung wie Sie Sourcecode der Programmiersprachen C++, C#, Delphi, IDL, Java, JavaScript, MATLAB and VB.NET in die Dokumentation integrieren können. Um den Sourcecode von sonstigen Sourcedateien in der Ausgabe zu inkludieren, wählen Sie im Dialog Allgemeinen Source bearbeiten die Optionen Use everything in the file oder Use comments and source till line aus. Weitere Informationen finden Sie in Dokumentieren von sonstigen Sourcedateien.

  1. Doc-O-Matic zeigt die Deklaration (automatisch von Doc-O-Matic erzeugt) für jedes Symbol an. Zusätzlich kann Doc-O-Matic die Deklaration auch in anderen Programmiersprachen anzeigen. Doc-O-Matic zeigt die Deklaration in HTML in Registern unter Syntax an.
  2. Um die Deklaration für Ihre Symbole in der von Ihnen verwendeten Programmiersprache wegzulassen, entfernen Sie die Markierung aus dem Kontrollkästchen Print declaration syntax in the original source language auf der Seite Mehrere Sprachen.
  3. Um die Syntax für andere Sprachen wegzulassen, deaktivieren Sie das Kontrollkästchen Print declaration syntax in multiple source languages auf der Seite Mehrere Sprachen.
  4. Um die Deklaration aus der Ausgabe zu entfernen, entfernen Sie die Markierung aus dem Kontrollkästchen neben dem Abschnitt Syntax auf der Seite Files & Format > Section Appearance.
  5. Um die Deklaration durch Ihre eigene Deklaration zu ersetzen, fügen Sie zum jeweiligen Thema den entsprechenden Syntax Abschnitt hinzu.
  1. Um die Implementierung anzuzeigen, wählen Sie auf der Seite Body-Source Add function's body source code oder Add file's body source code aus.
  2. Um die Syntax im Sourcecode hervorzuheben, und automatische Hyperlinks zu erstellen, aktivieren Sie die entsprechenden Kontrollkästchen auf der Seite AutoDoc > Code Options > Body-Source Code.
  3. Um die Sourcecodezeilen zu nummerieren, Tabulatoren zu erweitern und die Kommentare wegzulassen, markieren Sie die entsprechenden Kontrollkästchen auf der Seite AutoDoc > Code Options > Body-Source Code.
  4. Um die Funktion Body-Source für jedes Thema einzeln zu aktivieren, ändern Sie die Eigenschaft Body- Source in den Topic Properties oder fügen Sie den Implementation-Tag oder den XML kompatiblen Property-Tag und das Attribut Implementation im Kommentar ein.
  5. Die Implementierung wird als Abschnitt Body-Source und in den Hilfesystemen zusätzlich auf einer eigenen Seite ausgegeben. Um die Implementierung, die als Abschnitt ausgegeben wird, zu entfernen, müssen Sie auf der Seite Files & Format > Section Appearance das Kontrollkästchen neben Body-Source deaktivieren.
  6. Um die Seiten, auf denen die Implementierung in den Hilfesystemen ausgegeben wird zu entfernen, müssen Sie das Kontrollkästchen neben Body-Source auf der Seite Files & Format > Sections > Navigation Links > Format deaktivieren.
  7. Um Text zur Implementierung hinzuzufügen, müssen Sie zum entsprechenden Thema einen Abschnitt vom Typ Source Description hinzufügen.

Um den Deklarationsabschnitt zu formatieren, können Sie entweder das Formatierungselement Syntax verwenden oder für jede Programmiersprache ein eigenes Element anlegen.

Codeausgabeoptionen, Ausgabeoptionen

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