FPDoc Editor/de

Einleitung

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

Wo ist LazDoc zu finden??

Weil LazDoc sich noch in der Entwicklung befindet, und es nicht klar ist, ob es ein Teil von Lazarus selbst werden wird oder ein separates Package / Bibliothek, ist LazDoc nur verfügbar, wenn Lazarus kompiliert wird mit der -dEnableLazDoc Einstellung.

 make OPT="-dEnableLazDoc" clean all

Wenn sie Lazarus aus Lazarus heraus kompiliert haben, vergessen sie nicht, die Option im "Build Lazarus" Dialog zu setzen.

Gebrauch

Die Verwendung von LazDoc ist sehr einfach.

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

2. Setzen sie den Suchpfad für LazDoc in dem Einstellungen | Umgebungseinstellungen Dialog, unter der LazDoc 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 LazDoc Formulars ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentations Datei. Durch Auswahl der geeigneten Seite in LazDoc können sie ein spezifisches Dokumentations Tag bearbeiten. Natürlich ist es auch möglich, LazDoc nur als Betrachter zu nutzen.

Future plans

The todo list currently contains the following items, in no particular order:

• Add a HTML viewer
• Make it work on project files also
• Make LazDoc create new elements in documentation
• Propose to expand documentation tags with: "todo" and "notes"
• Add all documentation tags to LazDoc
• Add more source elements to be interpreted by LazDoc using exisiting code tools (now procedure/function/constructor/destructor)
• Reduce overhead even further
• Use IPC for communication

DONE

• Make it work for fpc sources (rtl files already exist)
• Add settings to environment menu