При запуске phpdoc в проекте CodeIgniter какие папки следует включать?

Question

С первой попытки я включил только систему / приложение / модели, систему / приложение / контроллеры, систему / приложение / помощники и систему / приложение / библиотеки. Я выбрал эти папки, потому что я думаю, что эти папки содержат код, который вы хотите правильно задокументировать для дальнейшего использования. Какие другие папки, по вашему мнению, должны быть включены?

Answer 1

Быть тщательным с точки зрения вашего собственного кода. Я бы порекомендовал следующие папки и там, где это необходимо, аннотировал:

1. система / приложение / контроллеры
2. система / приложение / хелперы
3. system / application / hooks - Не пропустите это! Каждый раз, когда вы меняете / расширяете ядро ​​CI, вы обязательно должны задокументировать это
4. система / приложение / модели
5. система / приложения / библиотеки
6. system / application / language - Это может пригодиться при реализации локализации
7. system / plugins - Поскольку вы включаете библиотеки, имеет смысл включить также любые внешние подключаемые модули

Answer 2

Я думаю, что вы это покрыли. Остальное, вероятно, уже задокументировано в документации CodeIgniter.

Если вы добавляете какой-либо плагин / библиотеку / все, что требуется, чтобы находиться вне этих папок, убедитесь, что вы добавите их позже.