wie phpdoc Tutorial/Erweiterte-Seiten erstellen Code zu ergänzen, kommentierte

Question

ich alles versuche ich kann phpDocumentor zu bekommen, mir zu erlauben, die DocBook Tutorial-Format zu verwenden, um die Dokumentation zu ergänzen, es schafft:

1. ich verwende eclipse-
2. habe ich phpDocumentor über PEAR auf einem OSX Maschine
3. installiert ich betreibe und auto können Code aus meiner pHP-Klassen generieren
4. Es wird nicht Tutorials Format - ich kann keine Lösung
finden

Ich habe versucht, die .pkg Beispieldatei über die Dateistruktur in Unterordnern zu verschieben, die einen ähnlichen Namen wie das Paket verwendet, auf das im Code verwiesen wird. Ich bin wirklich ratlos - wenn jemand WHERE erklären könnte sie legen die .pkg und andere DocBook-Dateien in Bezug auf den Code, den sie dokumentieren und wie sie phpdoc auslösen es zu formatieren, ich würde es zu schätzen wissen, ich das im Moment bin mit:

phpdoc -o HTML:Smarty:HandS 
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/" 
-t /path/to/output 

Answer 1

Ich habe nicht erwartet, meine eigene Frage zu beantworten, aber nach 2 Tagen Geist Biegen Schmerzen und ein Wochenende zu experimentieren es scheint, das ist das Problem:

Das Tutorial und meine Beispiele sollten funktionieren, aber scheint es einen kleinen Fehler in der Art zu geben, wie phpdoc die Switch-Werte interpretiert. Hier ist, was ich habe mit:

phpdoc -o HTML:Smarty:HandS 
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/" 
-t /path/to/output 

Allerdings, wenn Sie die folgende verwenden:

phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/ 
-t /path/to/output 

Es wird richtig Ihre Tutorials und sich Docs-Format, alles, was ich tat, war die doppelten Anführungszeichen fallen Umgeben der Verzeichnispfade. Einfache Anführungszeichen funktionieren überhaupt nicht - da phpdoc selbst die Verzeichnisse in doppelten Anführungszeichen umschließt, wenn keine Leerzeichen vorhanden sind ... scheint dies ein Fehler mit phpdoc zu sein, und das gleiche Verhalten ist bei der webbasierten Schnittstelle aufgetreten, also ein interner Problem. Mein ursprünglicher Versuch hätte funktionieren sollen, aber ich werde die Entwickler nicht kontaktieren und auf sie aufmerksam machen.

Problem gelöst.

Answer 2

Haben Sie this lesen ?

Es schlägt das folgende Pfadschema vor: tutorials/package.pkg wo Paket ist der Name Ihres Pakets, haben Sie es so gemacht?

Answer 3

Ja, Ihre Verwendung der doppelten Anführungszeichen warf wahrscheinlich das interne Laufzeitargument phpDocumentor ab, was dazu führte, dass -d /path/to/code/classes ein Arg/Wert-Paar war, ohne /path/to/code/docs/tutorials als zusätzlichen Verzeichniswert einzubeziehen.

In der Regel habe ich zwei andere Probleme bei der Erstellung von Lernprogrammen gesehen. Erstens, das tutorial-Verzeichnis ist nicht das, was phpDocumentor erwartet. Zwei, keine tatsächlichen PHP-Code-Dateien sind in der Ausführung enthalten. Ich erinnere mich daran, dem Handbuch speziell Worte hinzuzufügen for these two scenarios.

Answer 4

Ich hatte das gleiche Problem mit einer .ini für die Konfiguration, aber bei mir war das Problem, dass ich ein Leerzeichen zwischen dem Komma und dem Verzeichnis, was dazu führte, dass das Verzeichnis nicht mit dem -d "verlinkt" Parameter.

Problem:

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials 

Arbeits:

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials 

Hope this sonst das Problem für jemand löst!