Как подключить phpDocumentor через composer?

Question

[krlljs]

Как подключить phpDocumentor через composer в уже существующий проект? Как запустить? Документация на этот счет скудна (про composer только тут)

И особенно что смущает, это запускать необходимо через команду phpdoc (ссылка):
$ phpdoc -d ./src -t ./docs/api

С оболочками командной строки linux я знаком, но в голове какая-то путаница. В composer обычно все зависимости кладутся в директорию vendor/. Мне нужно вручную bin/ создать, и чем наполнить phpdoc.php?

А с запуском куда мне переходить, в браузер? Какой адрес набирать, ведь ключ -S adres:port я не передавал. Это нормально, что у меня так много вопросов? Помогите мне начать использовать php-doc в своих проектах.

Answer 1

[krlljs]

composer.json

{
    "require-dev": {
        "phpdocumentor/phpdocumentor": "dev-master",
        "ext-xsl": "*"
    }
    "config": {
        "bin-dir": "bin"
    }
}

$ php composer.phar install

Возможно не установлено расширение php5-xsl, проверь

$ composer show --platform | grep ext-x
$ composer show --platform | grep ext-xls
$ sudo apt-get install php5-xls

Answer 2

[Сергей Протько]

читаем документацию к composer:
https://getcomposer.org/doc/

В частности в пакетах указываются бинарники. По умолчанию они ставятся (а точнее симлинки на них) в vendor/bin, но можно в composer.json попросить ложить их куда-то еще:

{
    "config": {
        "bin-dir": "bin"
    }
}

Comments

[krlljs]

@fesor я догадывался, и даже ведь знал. Но считаю, лучше спросить лишний раз, удостовериться в верности своего мышления. А ты сам используешь php-doc?

[Сергей Протько]

@krlljs, увы, или не увы, но нет.

Answer 3

[Назар Мокринский]

PhpDoc в первую очередь стоит использовать потому, что IDE сможет понять, что и куда должно передаваться, и будет производить статический анализ кода. То есть сможет подсказать, когда вы передаете объект или массив туда, где ожидается число. Ну и документация по методам и свойствам будет под рукой на расстоянии пол клика, меньше нужно будет в исходник смотреть, чтобы посмотреть типы входящих параметров.

Comments

[Сергей Протько]

есть разница, использовать PhpDoc в коде, и генерировать документацию по проекту на основе PhpDoc. Регламентировать там типа аргументов и что возвращает функция - это одно. А поддерживать документацию в актуальном состоянии - совсем другое.

[Назар Мокринский]

@Fesor Документацию в любом случае желательно поддерживать актуальной, а такую как PhpDoc проще других ибо она тут же вместе с кодом.
Генерация документации на основе PhpDoc это сложнее чем просто указывать типа, но к части вопроса о том как начать имеет самое непосредственное отношение.