Skip to content
Marko Schulz 01. December 2024 - 18:50 01. December 2024 - 18:50

phpDocumentor

phpDocumentor ist ein Format für Kommentar in PHP-Code in Anlehnung an Javadoc. Es dient dazu, Variablen, Funktionen, Methoden und Klassen in PHP-Quelltexten zu dokumentieren, um anhand dieser Angaben eine Dokumentation, etwa auf HTML-Basis, zu erstellen.

Installation

Die Installation ist einfach nur ein Download von phpDocumentor.phar und das verschieben (umbenennen) nach /usr/local/bin/ und das ausführbar machen des /usr/local/bin/phpDocumentor.

wget https://phpdoc.org/phpDocumentor.phar && \
    chmod +x phpDocumentor.phar && \
    sudo mv phpDocumentor.phar /usr/local/bin/phpDocumentor

Wichtige phpDocumentor Argumente

-d oder --directory:

  • Gibt das Verzeichnis oder die Datei(en) an, die dokumentiert werden sollen.
  • Beispiel: -d /path/to/src

-t oder --target:

  • Legt das Verzeichnis fest, in dem die generierte Dokumentation gespeichert wird.
  • Beispiel: -t /path/to/doc

-f oder --filename:

  • Falls du eine bestimmte Datei statt eines Verzeichnisses dokumentieren möchtest, kannst du hier den Dateinamen angeben.
  • Beispiel: -f /path/to/file.php

-c oder --config:

  • Spezifiziert eine Konfigurationsdatei für phpDocumentor. Diese Datei enthält Einstellungen und Optionen, die für komplexere Projekte hilfreich sind (z. B. phpdoc.xml oder phpdoc.dist.xml).
  • Beispiel: -c /path/to/phpdoc.xml

--template:

  • Wählt das Template für die Ausgabe aus. Standardmäßig nutzt phpDocumentor das Template default, aber es gibt auch andere Templates (z. B. clean oder responsive).
  • Beispiel: --template="clean"

--ignore:

  • Ermöglicht das Ignorieren bestimmter Dateien oder Verzeichnisse. Praktisch, wenn du bestimmte Dateien wie Tests oder temporäre Dateien ausschließen möchtest.
  • Beispiel: --ignore="tests/*"

--setting:

  • Übernimmt bestimmte Einstellungen direkt über die Kommandozeile.
  • Beispiel: --setting="visibility=public"

--visibility:

  • Gibt an, welche Sichtbarkeiten (z. B. public, protected, private) in die Dokumentation einbezogen werden sollen. Das ist nützlich, um nur bestimmte Methoden und Eigenschaften anzuzeigen.
  • Beispiel: --visibility="public,protected"

--title:

  • Legt den Titel für die Dokumentation fest. Dieser erscheint dann auf der Startseite der Dokumentation.
  • Beispiel: --title="Mein Projekt"

--force:

  • Erzwingt die Generierung der Dokumentation, auch wenn Fehler auftreten sollten.

Beispiel-Kommando mit verschiedenen Argumenten

Angenommen, du hast ein größeres Projekt und möchtest nur public und protected Methoden dokumentieren, ein spezielles Template verwenden und eine phpdoc.xml Konfiguration einbeziehen:

phpDocumentor -d /path/to/src -t /path/to/doc --template="clean" --visibility="public,protected" -c /path/to/phpdoc.xml --title="Projekt Dokumentation"

Diese Argumente bieten dir viele Möglichkeiten, die Dokumentation exakt an die Anforderungen deines Projekts anzupassen.