Doxygen vs. Phpdocumentor

Gesperrt
tono
Beiträge: 574
Registriert: Mo 25. Apr 2005, 20:51
Wohnort: Frankfurt am Main
Kontaktdaten:

Doxygen vs. Phpdocumentor

Beitrag von tono »

Die Contenido-API-Dokumentation wird ja offiziell für Doxygen geschrieben und mit Doxygen erstellt.

Allerdings finden sich in den Komentatblöcken viele Tags, die eindeutig der Syntax von phpdocumentor entstammen und von Doxygen auch nicht verarbeitet werden können.

Auch von Seiten 4FB wird phpdocumentor als das Dokumentationswerkzeug angegeben z.B. hier: http://contenido.org/forum/viewtopic.php?p=5094#5094

Aber auch phpdocumentor hat viel an der vorhandenen Dokumentation zu kritisieren (unknown Tags, warnings).

Beide Werkzeuge haben ihre Vorteile und Tücken, aber ich finde man sollte sich auf eines festlegen, nur so erhält man eine saubere Dokumentation.

Wenn klar ist welches Werkzeug zum Einsatz kommt, würde ich mich auch bereiterklären die vorhangene Dokumentation dafür zu optimieren und zu ergänzen.
Bis dann
Tono
xmurrix
Beiträge: 3215
Registriert: Do 21. Okt 2004, 11:08
Wohnort: Augsburg
Hat sich bedankt: 4 Mal
Danksagung erhalten: 17 Mal
Kontaktdaten:

Beitrag von xmurrix »

Hallo,

afaik hat sich PhpDocumentor für die Dokumentation von PHP-Projekten durchgesetzt.

Ich persönlich empfinde das Arbeiten mit PhpDocumentor spezifischen Tags angenehmer und würde es auch begrüßen, wenn die Sourcen von Contenido entsprechend Dokumentiert werden.

Grüße
xmurrix
Gesperrt