Doxygen vs. Phpdocumentor
Verfasst: So 30. Dez 2007, 15:18
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.
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.