Doxygen: Automatisiert Grundstruktur erstellen?

01/01/2016 - 23:32 von Michael Vogel | Report spam
Moin!

Bei unserem Projekt haben wir uns entschlossen, mit Hilfe von Doxygen
unsere Dokumentation zu erstellen.

Ich nutze "nano" als Editor. Ich befürchte, dass es dafür keine
Möglichkeit gibt, Doxygen direkt einzubinden.

Deswegen ist meine Hoffnung, dass es ein Script für die Kommandozeile
gibt, das den Code analysiert und eine Grundstruktur anlegt, d.h. dass
es die Parameter und den Rückgabewert dokumentiert, so dass man nur noch
die Dokumentation erweitern muss.

Gibt es das?

Michael
 

Lesen sie die antworten

#1 Thomas PointedEars Lahn
02/01/2016 - 22:55 | Warnen spam
Michael Vogel wrote:

Deswegen ist meine Hoffnung, dass es ein Script für die Kommandozeile
gibt, das den Code analysiert und eine Grundstruktur anlegt, d.h. dass
es die Parameter und den Rückgabewert dokumentiert, so dass man nur noch
die Dokumentation erweitern muss.

Gibt es das?



Mir ist keins bekannt. Aber sowohl PDT für Eclipse (in Java) als auch
language-php für Atom (in V8 JavaScript) müssen entsprechenden Code
enthalten, da sie bei Eingabe von /**<RET> vor einer Funktionsdeklaration
entsprechende PHPDoc-Kommentare generieren.

Wenn ich Doxygen richtig verstanden habe, wirst Du aber die Kommentare
ohnehin bearbeiten müssen, so dass Du Dich fragen solltest, ob es sich
lohnt, ein Script für das PHPDoc-Grundgerüst zu suchen/schreiben.

PointedEars
Zend Certified PHP Engineer
Twitter: @PointedEars2
Please do not cc me. / Bitte keine Kopien per E-Mail.

Ähnliche fragen