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

The big brother of the FPDoc Editor is lazde the lazarus documentation editor. It is a standalone application which can be found in ($LazDir)/doceditor/lazde.lpi, and needs to be compiled using the IDE then runs outside the IDE.

Wo ist FPDoc zu finden?

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

Gebrauch

Die Verwendung von FPDoc ist sehr einfach.

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

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

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, daß sich die Beschriftung des FPDoc Formulars ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentations Datei. 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 die folgenden Punkte, in keiner besonderen Reihenfolge:

• Einen HTML Viewer hinzufügen; LazDoc wird die Dokumentation automatisch erzeugen
• Auch das Bearbeiten von Projektdateien ermöglichen
• Das Erstellen neuer Elemente mit LazDoc in der Dokumentation ermöglichen
• Vorschlag die Dokumentations Tags zu erweitern mit: "todo", "notes" und "topic"
• Alle Dokumentations Tags zu LazDoc hinzufügen
• Mehr Quellen Elemente 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
• Make LazDoc create new documentation files
• LazDoc zu den IDE Einstellungen hinzufügen (showing and position in IDE)
• Make LazDoc work on keydown in sourceeditor (broken)
• 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 Umgebungseinstellungen Menü hinzufügen
• Adding a small toolbar makes it possible to use the available makeup tags.
• documentation tags "seealso" zu LazDoc hinzufügen
• Make it work on project files also
• Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives)
• Overhead noch weiter reduzieren
• Find inherited entries. Zum Beispiel TControl.Align von TButton.Align.
• Optimierung: inherited Entries werden bei Leerlauf (des Prozessors) analysiert.
• Optimierung: XML Dateien are cached, and only parsed once or if they changed on disk