Bei der Ausführung phpdoc auf einem CodeIgniter Projekt, das Ordner enthalten sein sollte?

Question

Bei meinem ersten Versuch habe ich nur enthalten System / application / Modelle, System / application / controllers, System / application / Helfer und System / application / Bibliotheken. Ich habe mich für diese Ordner, weil ich glaube, dass diese Ordner den Code enthalten, die Sie wollen für die Zukunft richtig zu dokumentieren. Welche anderen Ordner denken Sie, sollten einbezogen werden?

Answer 1

Um in Bezug auf Ihren eigenen Code gründlich. Ich würde die folgenden Ordner empfehlen und wo notwendig sind kommentierte:

1. System / application / controllers
2. System / application / Helfer
3. System / application / Haken - nicht verpassen! Jedes Mal, dass Sie ändern / erweitern den CI-Kern, Sie sollten auf jeden Fall zu dokumentieren
4. System / application / Modelle
5. System / application / Bibliotheken
6. System / application / Sprache - Diese als nützlich erweisen kann, wenn die Lokalisierung der Umsetzung
7. System / plugins - Wie Sie Bibliotheken sind einschließlich, wäre es sinnvoll schließen alle externen Plugins auch verwendet werden

Answer 2

Ich glaube, Sie haben es erfasst. Der Rest wird wahrscheinlich schon in CodeIgniter Dokumentation dokumentiert.

Wenn Sie eine Plugin / Bibliothek hinzufügen / was auch immer, dass außerhalb dieser Ordner sein erfordert, stellen Sie sicher, dass Sie sie auch später hinzufügen.