Ich mache eine selbstgebraute automatisierte Dokumentation, da ich eine Codebase habe, die in ihrem Layout nicht sehr Standard ist, und ich frage mich, was der beste Weg war, eine PHP-Datei zu lesen und den Inhalt eines Kommentarblocks zu erfassen . Die einzige Möglichkeit, das zu tun, ist, die Datei zu öffnen und Zeile für Zeile zu lesen, aber ich dachte mir, dass es vielleicht eine eingebaute Magie gibt, die das Dokument für mich parsen würde, ähnlich den Reflection-Funktionen. p>
Das grundlegende Layout jeder Datei ist wie folgt:
%Vor%Es ist wichtig zu beachten, dass in diesen Dateien keine Funktionen oder Klassen definiert sind. Die Kommentare beziehen sich auf das Skript als Ganzes.
Besuche Tokenizer .
Um alle Kommentare in einer Datei namens test.php zu erhalten, tun Sie Folgendes:
Sehen Sie sich die Reflection-API von PHP5 an, genauer gesagt getDocComment() :
PHP 5 kommt mit einer vollständigen Reflexion API, die die Fähigkeit hinzufügt Reverse-Engineering-Klassen, Schnittstellen, Funktionen und Methoden sowie Erweiterungen. Zusätzlich, die Reflection API bietet auch Möglichkeiten Dokumentkommentare für Funktionen abrufen, Klassen und Methoden.
Abhängig von der Größe Ihrer Codebasis arbeiten Sie möglicherweise auch weniger, indem Sie Ihre Kommentare an die phpDocumentor -Syntax anpassen scheint schon ziemlich nah.
Mit getDocComment() , wenn mehrere Kommentare vorhanden sind, gilt die letzte gefundene
Tags und Links php reflection comments