Какие каталоги Codeigniter я должен предоставить композитору для создания технической документации?

Question

Я использую PhpDocumentor для создания технической документации для проекта Codeigniter.

Я знаю, как создать документацию для простого проекта PHP, но создать документацию для проекта CodeIgniter довольно сложно, так как я не знаю, куда мне поместить папку своего поставщика и какой каталог (например, приложение или контроллеры) Я должен предоставить композитору.

Я не нашел ни решения, ни учебника, ни статьи по интеграции PHPDOC с CODEIGNITER. Поэтому небольшая помощь или ссылка на решение будут высоко оценены.

Или кто-то может порекомендовать инструмент, который лучше, чем phpdoc, и может легко интегрироваться с CodeIgniter. Это будет очень полезно

Answer 1

Для документирования приложения обычно есть два подхода, и некоторые люди делают оба по отдельности.

Для пользователя / потребителя в документах будет отображаться только используемый API. Это требует, чтобы вы были очень точны в отношении того, какие несколько файлов / классов включать. Некоторые используют тег @api для обозначения классов и методов, но я не уверен, какие генераторы документов распознают этот тег.

Для документов для разработчиков вы должны включать все из своего собственного кода, но большинство людей не включают зависимости от vendor/. Но если вам нужны действительно полные документы, чтобы любой класс зависимостей также присутствовал в документах, вы должны включить vendor/. В этом случае, где вы находите эту папку, на самом деле не имеет значения, пока вы говорите генератору документации, чтобы она была включена.