jobs920.com

  

Beste Artikel:

  
Main / Doxygen PHP wie man

Doxygen PHP wie man

Der Vorschlag ist eigentlich sehr einfach: Die meisten Entwickler sind sich dessen sowieso bewusst, da sie die technische Dokumentation jeden Tag selbst verwenden. Ein Versuch, PHP-Interna zu dokumentieren, wurde bereits vor einigen Jahren von Jefferson Gonzalez gestartet, um Phoxygen bei GitHub zu sehen, der jedoch aufgrund von Freizeitmangel abgebrochen wurde.

Dieser RFC schlägt kein großes Dokumentationsfest vor, bei dem die Entwicklung gestoppt wird und jeder anfängt, Dokumentation zu schreiben. Beginnen Sie lieber in der Zukunft mit der Dokumentation sowie beim Umgestalten oder Umschreiben von vorhandenem Code.

Die Zielgruppe unserer Dokumentation sollten Mitentwickler sein, die mit der Entwicklung von PHP-Interna beginnen möchten. Daher sind Beispiele normalerweise das Wichtigste. Doxygen unterstützt mehrere Formate. Aufgrund unserer Anforderung, mit dem C89-Standard kompatibel zu sein, können jedoch nur zwei für uns verwendet werden. Die genauen Funktionen sowie die verfügbaren Tags werden in der Doxygen-Dokumentation ausführlich erläutert und in diesem RFC nicht wiederholt.

Ein paar Empfehlungen bezüglich des Stils der Kommentare sind vielleicht gut: Die folgenden erweiterten Beispiele könnten ebenfalls von Interesse sein. Sie enthalten eine umfangreiche Dokumentation, möglicherweise sogar zu viel: Dokumentation erstellen und online veröffentlichen, damit Benutzer sie durchsuchen können.

Wir könnten sie direkt auf GitHub Free Hosting veröffentlichen oder einen separaten Bereich innerhalb der offiziellen PHP-Website erstellen, auf den sie zugreifen können. Doxygen-Version: Erstveröffentlichung unter: Vorschlag, den Doxygen-Dokumentationsstil für die C-Quellen der statischen PHP-Quellen […] zu übernehmen, scheint noch effektiver zu sein, wenn Dokumentation hinzugefügt wird, da sich beide Hilfen gegenseitig zu verstärken scheinen. Es gibt eine umfangreiche Dokumentation zum Schreiben guter Java-Dokumente.

Es ist sehr nah an PhpDoc oder sogar fast gleich. Dies bedeutet, dass die Eintrittsbarriere für typische PHP-Entwickler sehr niedrig ist. Kommentare werden vor dem Strukturelement platziert, das dokumentiert werden soll, mit Ausnahme von Dateien, die nicht möglich sind (siehe unten). H-Datei. C-Datei. Mit Doxygen dokumentieren?

(с) 2019 jobs920.com