Wenn phpdoc in einem CodeIgniter-Projekt ausgeführt wird, welche Ordner sollten enthalten sein?

Question

Bei meinem ersten Versuch habe ich nur System/Anwendung/Modelle, System/Anwendung/Controller, System/Anwendung/Helfer und System/Anwendung/Bibliotheken enthalten. Ich habe diese Ordner ausgewählt, weil ich denke, dass diese Ordner den Code enthalten, der für die spätere Verwendung ordnungsgemäß dokumentiert werden soll. Welche anderen Ordner sollten Ihrer Meinung nach enthalten sein?

Answer 1

Um in Bezug auf Ihren eigenen Code gründlich zu sein. Ich würde die folgenden Ordner empfehlen und gegebenenfalls mit Anmerkungen versehen haben:

1. System/application/controllers
2. System/application/Helfer
3. System/application/Haken - nicht verpassen das raus! Jedes Mal, dass Sie das CI-Kern ändern/erweitern, sollten Sie auf jeden Fall zu dokumentieren
4. System/application/Modelle
5. System/application/Bibliotheken
6. System/application/Sprache - Dies kann kommen in nützlich bei der Umsetzung von Lokalisierungs
7. System/plugins - wie Sie Bibliotheken sind einschließlich, wäre es sinnvoll, alle externen Plugins umfassen machen auch verwendet werden

Answer 2

Ich denke, Sie haben es abgedeckt. Der Rest ist wahrscheinlich bereits in der Dokumentation von CodeIgniter dokumentiert.

Wenn Sie ein Plug-in/eine Bibliothek/was auch immer hinzufügen, das außerhalb dieser Ordner benötigt wird, stellen Sie sicher, dass Sie sie später hinzufügen.