FPDoc Editor/de

This is an old revision of FPDoc Editor/de, edited by Af0815 at . The current revision is 12261.

/* Einleitung */ closer to english version

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.

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.

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 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 wird dann automatisch speichern.

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 Menü/Einstellungen/Umgebung/FPDoc-Editor hinzu.

Machen Sie einen Terst mit TComponent.Name.

Zukünftige Pläne

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

Erledigt