phpDoc

[Pendergast]

Servus,

gestern ist mir das Licht aufgegangen, dass ich meine Klassen eigentlich mal vernünftig dokumentieren müsste (verdammt ist das zäh, wenn man das vorher nie getan hat!), wenn die auch mal wer anders als ich selbst verwenden soll. Natürlich tu ich das mit dem phpDocumentor.

Auch wenn es hier im Forum zu phpDoc erschreckend wenige Suchergebnisse gibt wirds der ein oder andere hoffentlich schon etwas länger verwenden und kann mir zwei kurze Fragen beantworten:

Die Überschrift scheint sich am ersten gefundenen Package zu orientieren, was für mich aber keinen Sinn macht, wenn ich ein paar Klassensammlungen dokumentieren will, die nicht wirklich miteinander verwandt sind. So lautet die Überschrift meiner Doku nun "FormBuilder", die aber die Pakete "FormBuilder", "Mail", "SQL" und "Template" enthält... Natürlich kann ich per Hand im Dokuheader meinen gewünschten Titel eintragen, aber beim nächsten Kompilieren der Hilfe darf ichs dann wieder machen, usw. Hab in der Doku von phpDoc leider keine Möglichkeit zum Setzen vom Titel gefunden. Ideen oder Workarounds?

Desweiteren sagt mir nicht eins der mitgelieferten Designs der Dokumentationen wirklich zu, fürs Selbstdesign hab ich nicht auch noch Zeit, und die Suchmaschine meines Vertrauens liefert mir keine Ergebnisse. Hat jemand vielleicht einen Geheimtip parat, wo man ein paar vernünftige Designs dafür herbekommt?

 

[rythms]

Ich benutze momentan das Webinterface für phpDoc (docBuilder).

Dort kannst du unter dem Tab [Options] einen Seitentitel eingeben.

Als Design benutze ich das SmartyHP Design.
Das PHP MAnual ist doch schön übersichtlich?

 

[Pendergast]

Stimmt, im Webinterface bekommt man die Möglichkeit Titel anzugeben. Da muss es doch auch Optionen für das Kommandozeilentool geben oder irgendwelche Tags für die Doku? Leider werd ich das nicht fündig. Und das Webinterface funktioniert bei mir dummerweise auch nicht.

Und zum Design: Die Standarddesigns haben alle irgendwelche Merkmale, die mir nicht zusagen. Bei SmartyHP werden z.B. erst alle Dateien aufgelistet, die mich aber überhaupt nicht interessieren, die Klassen selbst sind mir doch viel wichtiger. Was SmartyHP anderen Designs voraus hat ist, dass vererbte Methoden mit Kurzbeschreibung am Anfang jeder Datei stehen - aber die eigenen Klassenmethoden sind völlig undokumentiert als einfache Linkliste aufgeführt und der schnelle Überblick fehlt, was welche Methode letztlich tut... So geht's dann mit jedem Design - irgendwas gefällt mir ganz gut und bei anderen Dingen kann ich nur mit dem Kopf schütteln...
Natürlich kann ich mich mit irgendeinem Template hinsetzen und schauen, wie ich alle meine Wünsche irgendwie noch unterbringen kann. Ich hätte halt gehofft, dass irgendwer ne tolle Quelle kennt, wo man mal schnell x Templates runterladen, ausprobieren und gucken kann, wo die Schnittmenge denn am größten ist.