Erzeugen einer HTML-Dokumentation


Ed42 erlaubt es, strukturierte Kommentare in eine HTML-Dokumentation zu übersetzen. Über Kommentare|HTML-Dokumentation erzeugen kann ein Dialog aufgerufen werden, der es ermöglicht, entweder für die aktuelle Datei oder für eine Dateigruppe die zugehörige HTML-Dokumentation zu erzeugen. Grundsätzlich wird für jede Datei eine HTML-Datei erzeugt. In der erzeugten HTML-Datei wird für jeden strukturierten Kommentar der Quelldatei ein Abschnitt eingefügt. Zusätzlich wird am Beginn der HTML-Datei eine Zusammenfassung der Klassen/Prozeduren/Fuktionen/Typen erstellt.

Die Namenskonvention für die zu erzeugenden HTML-Files sowie das Verzeichnis, in dem diese Dateien abgelegt werden solle, sind über die Projektoptionen (Registerkarte HTML-Erzeugung) einstellbar.

Soll die HTML-Dokumentation für eine Dateigruppe erstellt werden, kann zusätzlich (ebenfalls über die Projektoptionen) eine Standardvorgabe für diese Dateigruppe definiert werden. Vor der Erzeugung der HTML-Dateien kann der Benutzer die Dateigruppe, die dieser Standardvorgabe entspricht, modifizieren (durch das Hinzufügen und Entfernen einzelner Dateien).

Soll lediglich die HTML-Dokumentation für die aktuelle Datei erzeugt werden, kann der Benutzer wählen, ob ausschließlich der markierte Bereich der Datei berücksichtigt werden soll (falls ein solcher vorhanden ist) oder ob die gesamte Datei bearbeitet werden soll. Ferner kann der vorgegebene (über die Einstellungen der Projektoptionen gebildete) Namen der zu erzeugenden HTML-Datei geändert werden.


Last Change: 27.10.2001
© Copyright by Stefan Brüning. All rights reserved