FPDoc Editor/de

Einleitung

LazDoc ist ein integrierter Editor/Betrachter für Lazarus. Hierzu beschriebene Elemente und der Gebrauch von LazDoc selbst erfordern von Ihnen, mit FPDoc vertraut zu sein. Für mehr Informationen siehe: Free Pascal Dokumentationstool Handbuch

LazDE - Lazarus Documentation Editor

Der große Bruder des FPDoc Editor ist lazde der Lazarus-Dokumentationseditor. Er ist ein eigenständiges Programm und befindet sich in ($LazDir)/doceditor/lazde.lpi. Er muss mit der IDE übersetzt werden und läuft dann außerhalb der IDE.

Wo ist FPDoc zu finden?

FPDoc ist in die Lazarus IDE integriert. Es ist im Menü "Ansicht" zu finden.

Gebrauch

Die Verwendung von FPDoc ist sehr einfach.

1. Öffnen sie den FPDoc Editor. Sie können ihn im Menü "Ansicht" finden.

2. Setzen sie den Suchpfad für FPDoc im Dialog Projekt | Projekteinstellungen ..., unter der Registerseite FPDoc.

3. Öffnen oder wählen sie eine Datei, für die eine Dokumentation existiert.

4. Setzen und bewegen sie den Cursor. Nachdem der Cursor im Quelltext-Editor platziert wurde, werden sie beobachten, dass sich die Beschriftung des Formulars FPDoc ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentationsdatei. Durch Auswahl der geeigneten Seite in FPDoc können sie ein spezifisches Dokumentations-Tag bearbeiten. Natürlich ist es auch möglich, FPDoc nur als Betrachter zu nutzen.

Zukünftige Pläne

Die todo-Liste enthält gegenwärtig folgende Punkte, in keiner besonderen Reihenfolge:

• Einen HTML-Viewer hinzufügen; LazDoc wird die Dokumentation automatisch erzeugen
• Das Bearbeiten von Projektdateien ermöglichen
• Das Erstellen neuer Elemente mit LazDoc in der Dokumentation ermöglichen
• Die Dokumentations-Tags zu erweitern mit: "todo", "notes" und "topic"
• Alle Dokumentations-Tags zu LazDoc hinzufügen
• Mehr Quellenelemente für die Interpretation durch LazDoc hinzufügen unter Verwendung existierender Code-Werkzeuge (jetzt werden procedure/function/constructor/destructor unterstützt)
• Den Overhead noch weiter zu reduzieren
• IPC für die Kommunikation benutzen
• Erzeugung neuer Dokumentationsdateien mit LazDoc
• LazDoc zu den IDE-Einstellungen hinzufügen (Anzeige und Position in der IDE)
• LazDoc soll auf "keydown" im Sourceeditor reagieren (derzeit defekt)
• LazDoc zu einem WYSIWYG-Editor zu machen, vergleichbar mit einem Richtext-Editor.

Erledigt

• Arbeiten für FPC-Quellen zu schaffen (rtl Dateien existieren bereits)
• Einstellungen zum Menü "Umgebungseinstellungen" hinzufügen
• Hinzufügen einer kleinen Werkzeugleiste mit den verfügbaren Makeup-Tags.
• Dokumentations-Tags "see also" zu LazDoc hinzufügen
• Bearbeitung von Projektdateien ermöglichen
• Die Dokumentations-Tags zu erweitern mit: "todo" and "notes" (Kein Grund. Es gibt Alternativen)
• Overhead noch weiter reduzieren
• Finde geerbte Einträge. Zum Beispiel TControl.Align von TButton.Align.
• Optimierung: geerbte Einträge werden bei Leerlauf (des Prozessors) analysiert.
• Optimierung: XML-Dateien werden gecached und nur einmal geparsed bzw. nur wenn sie sich auf der Festplatte änderten.