FPDoc Editor/de

│ Deutsch (de) │ English (en) │ français (fr) │ 日本語 (ja) │ polski (pl) │ português (pt) │ русский (ru) │

Zurück zu den Zusätzlichen Informationen.

Einleitung

FPDoc ist das Free-Pascal-Dokumentationswerkzeug speziell zum Erzeugen von Hilfedateien für individuelle Einheiten vom Pascal Quellkode. Für mehr Informationen siehe: Free Pascal Dokumentationstool Handbuch (englisch).

Lazarus liefert einen eingebauten FPDoc Hilfe Betrachter und zwei Editoren mit zum Erzeugen beziehungsweise Aktualisieren der FPDoc Quelltext Dokumentation. Einen einfachen, eingebauten names FPDoc Editor, der auf dieser Seite beschrieben wird, und einen vollständigen und aufwendigeren Editor namens LazDE.

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. Sie können ihn als externes Werkzeug zum Werkzeugemenü hinzufügen.

Benutzung des FPDoc Editors

Die Verwendung von FPDoc ist sehr einfach.

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

2. Setzen und bewegen Sie den Cursor. Nachdem der Cursor im Quelltext-Editor platziert wurde, werden Sie bemerken, 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.

3. Klicken Sie auf die Schaltfläche 'Hilfe erzeugen'. Falls Sie die FPDoc-Suchpfade noch nicht eingerichtet haben, wird die IDE Sie fragen, wo die FPDoc-Dateien gespeichrt werden sollen. Für Projekte werden Sie normalerweise ein Unterverzeichnis 'docs' nehmen.

4. Schreiben Sie eine kurze Beschreibung.

5. Klicken Sie auf den Speichern-Knopf links oder gehen Sie zum nächsten Element (Der Editor speichert automatisch, wenn sie das Element verlassen).

Bearbeiten von FPDoc-Einträgen von LCL- und Lazarus-Quellen

Die sind in den Verzeichnissen ($LazDir)\docs\xml, sie können diese Verzeichnisse zu den FPDoc Pfaden unter Werkzeuge / Einstellungen / FPDoc-Editor hinzufügen.

Bearbeiten von FPDoc-Einträgen von FPC-Quellen, RTL und FCL

Die FPDoc-Einträge von FPC-Quellen können von SVN heruntergeladen werden:

cd /home/username/yourchoice/
svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs

Fügen Sie den Pfad /home/username/yourchoice/fpcdocs unter Werkzeuge / Einstellungen / FPDoc-Editor hinzu.

Ein gutes Elment für einen Test ist TComponent.Name.

Zukünftige Pläne

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

• Einen Hilfeeditor für Themen schreiben.
• Nettere html-Ausgaben für die Tooltips (Hinweisfenster) erzeugen.
• Unterstützung von Operatoren

Erledigt

• Den Linkeditor erweitert um Packages und Bezeichner anzuzeigen
• Dokumentationsmarkierungen "example" im FPDoc-Editor angefügt
• Dokumentationsmarkierungen "topic" im FPDoc-Editor angefügt
• FPDoc-Editor erzeugt neue Elemente in der Dokumentation
• FPDoc-Editor erzeugt neue Dokumentationsdateien
• Eine kleine Werkzeugleiste mit den verfügbaren Makeup-Tags hinzugefügt
• FPDoc-Editor arbeitet auf Tastendruck im Quelltexteditor
• FPDoc-Editor in den IDE-Einstellungen berücksichtigt (Anzeige und Position in der IDE)
• Ihn mit FPC-Quellen zum Laufen bringen (rtl Dateien existieren bereits)
• Einstellungen zum Menü "Umgebungseinstellungen" hinzugefügt
• Bearbeitung von Projektdateien ermöglicht
• Die Dokumentations-Tags erweitert mit: "todo" and "notes" (Kein Grund. Es gibt Alternativen)
• Overhead noch weiter reduziert
• Alle Quellelemente werde von FPDoc-Editor mittels der CodeTools interpretiert.
• 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.
• Einen HTML-Viewer hinzufügen; Dieser ist verfügbar durch Installation des Packages 'turbopoweriprodsgn'.
• Checks nach ungültigen xml-Tags und automatische Reparaturen