Документирование (генерация доки) проекта на Yii2

Общие вопросы по использованию второй версии фреймворка. Если не знаете как что-то сделать и это про Yii 2, вам сюда.
Ответить
quasar
Сообщения: 109
Зарегистрирован: 2014.10.22, 09:27

Документирование (генерация доки) проекта на Yii2

Сообщение quasar »

Здравствуйте. Поделитесь идеями кто как генерирует документацию для Yii2? Когда пишешь достаточно большой проект возникает задача документировать код, потому что просто забывается что где описано. Знаю Yii вроде как автоматом генерирует через PhpDocumentor свою доку. Но вот ставлю документов на последнюю версию php 7.3 и он не хочет работать. У кого какие практики по созданию документации при написании проекта?
yiiliveext
Сообщения: 910
Зарегистрирован: 2019.08.13, 01:49

Re: Документирование (генерация доки) проекта на Yii2

Сообщение yiiliveext »

Что значит не хочет работать? Опишите конкретнее. Так же попробуйте на другой версии php или в другом окружении.
quasar
Сообщения: 109
Зарегистрирован: 2014.10.22, 09:27

Re: Документирование (генерация доки) проекта на Yii2

Сообщение quasar »

yiiliveext писал(а): 2020.01.26, 10:35 Что значит не хочет работать? Опишите конкретнее. Так же попробуйте на другой версии php или в другом окружении.
Можно просто ответить на поставленный вопрос? Чем пользуетесь и что сейчас в тренде? А потом я уже буду смотреть что лучше всего подойдет в моем случает. Потому что если сейчас начинать разбираться почему что то не сработало то это будут километры текста. Мне только описать свое окружение где работаю и что использую надо страницу исписать. А если в краце то есть комп с Ubuntu на котором стоит php и NetBeans. Скрипт генерации документации будет запускаться через NetBeans а значит в локальной операционке где PHP меняется с обновлениями и сейчас он 7.3.13. А перепробованные способы генераторов документации не дружат с новым PHP и постоянно лезут косяки в виде ошибок. Все проекты крутятся на виртуалках через вагрант. И теперь чтобы мне ломать локальную среду под какой то генератор надо хотя бы понимать что сейчас в тренде и активно поддерживается. А то наломаю дров а в итоге получится что та тулза уже давным давно не актуальна и не поддерживается. Поэтому хочу узнать что актуально и какие его плюсы а потом уже под это ломать окружение. И вариант типа сгенерируй через ssh виртуалки не подходит потому что будет использоваться именно меню NetBeansa к которому надо подцепить современную тулзу для генерации документации. В краце как то так.
KonstantinDigit
Сообщения: 13
Зарегистрирован: 2019.06.06, 16:28

Re: Документирование (генерация доки) проекта на Yii2

Сообщение KonstantinDigit »

Добрый день, так же возник вопрос, как можно генерировать документацию для проекта на yii2, чтобы в доке было описаны что делают actions, функции и тд. То есть дока непосредственно для разработчиков самого проекта. Я полазил по инету и нашел вот это https://github.com/yiisoft/yii2-apidoc это вроде встроенный в yii2 документатор, только его вроде нужно устанавливать. Я попробовал сделать это с помощью composer ввел composer require --prefer-dist yiisoft/yii2-apidoc в папке с проектом (где непосредственно расположен composer.json) и далее получил следующую ошибку:

Код: Выделить всё

$ composer require --prefer-dist yiisoft/yii2-apidoc

Using version ^2.1 for yiisoft/yii2-apidoc
./composer.json has been updated
Running composer update yiisoft/yii2-apidoc
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - yiisoft/yii2-apidoc[2.1.0, ..., 2.1.6] require phpdocumentor/reflection-docblock ^2.0.4 -> 
    found phpdocumentor/reflection-docblock[2.0.4, 2.0.5] but the package is fixed to 5.2.2 (lock file version) 
    by a partial update and that version does not match. Make sure you list it as an argument for the update command.
    - Root composer.json requires yiisoft/yii2-apidoc ^2.1 -> satisfiable by yiisoft/yii2-apidoc[2.1.0, ..., 2.1.6].

Use the option --with-all-dependencies (-W) to allow upgrades, downgrades and removals 
for packages currently locked to specific versions.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.
Что я делаю не правильно? Честно говоря впервые решил заняться документирование для проекта. Пробовал ставить этот пакет документации на чистый свежеустановленный шаблон yii2 basic.
KonstantinDigit
Сообщения: 13
Зарегистрирован: 2019.06.06, 16:28

Re: Документирование (генерация доки) проекта на Yii2

Сообщение KonstantinDigit »

Нашел ответ на свой же вопрос, если кратко то проблема в несовместимости компонентов, так как и зависимости yii2 и apidoc требуют разные версии одного и того же компонента, так написано здесь https://github.com/yiisoft/yii2-apidoc/issues/208
Codeception requires phpunit that requires phpspec/prophecy that requires
phpdocumentor/reflection-docblock in recent version while yiisoft/yii2-apidoc requires
an old version so you cannot have both at the same time, sorry.
KonstantinDigit
Сообщения: 13
Зарегистрирован: 2019.06.06, 16:28

Re: Документирование (генерация доки) проекта на Yii2

Сообщение KonstantinDigit »

Я так же попробовал Swagger для документирования, но он видимо сделан только для документирования API. Вопрос остался открытым, вообще как создать документацию для проекта yii2 именно для разработчиков, если я пишу комментарии в синтаксисе dockBlock к классам контроллеров, к actions, да ко всему что мне нужно, как сделать такую же документацию как создана для yii2, чтобы она была динамическая? Может быть кто знает? Поделитесь пожалуйста.
Аватара пользователя
samdark
Администратор
Сообщения: 9489
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Документирование (генерация доки) проекта на Yii2

Сообщение samdark »

yii2-apidoc юзать под PHP 7.
Ответить