Задать вопрос
@krlljs
php

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

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

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

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

А с запуском куда мне переходить, в браузер? Какой адрес набирать, ведь ключ -S adres:port я не передавал. Это нормально, что у меня так много вопросов? Помогите мне начать использовать php-doc в своих проектах.
  • Вопрос задан
  • 3600 просмотров
Комментировать
Подписаться 5 Оценить Комментировать
Решения вопроса 3
@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
Ответ написан
Комментировать
Комментировать
Fesor
@Fesor
Full-stack developer (Symfony, Angular)
читаем документацию к composer:
https://getcomposer.org/doc/

В частности в пакетах указываются бинарники. По умолчанию они ставятся (а точнее симлинки на них) в vendor/bin, но можно в composer.json попросить ложить их куда-то еще:
{
    "config": {
        "bin-dir": "bin"
    }
}
Ответ написан
2 комментария
2 комментария
nazarpc
@nazarpc
Open Source enthusiast
PhpDoc в первую очередь стоит использовать потому, что IDE сможет понять, что и куда должно передаваться, и будет производить статический анализ кода. То есть сможет подсказать, когда вы передаете объект или массив туда, где ожидается число. Ну и документация по методам и свойствам будет под рукой на расстоянии пол клика, меньше нужно будет в исходник смотреть, чтобы посмотреть типы входящих параметров.
Ответ написан
2 комментария
2 комментария
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы
Вакансии с Хабр Карьеры
PHP Developer
YCLIENTS • Москва
от 200 000 до 350 000 ₽
PHP разработчик
Ведисофт • Екатеринбург
от 25 000 ₽
Midlle PHP developer (backend)
ИТЦ Аусферр • Магнитогорск
от 100 000 до 160 000 ₽
Ещё вакансии
Заказы с Хабр Фриланса
Написать посты на игровую тематику (PlayStation) Telegram, VK
25 апр. 2024, в 16:21
15000 руб./за проект
DevOps настройка Gitlab CICD для проекта c CF Worker
25 апр. 2024, в 16:12
2000 руб./за проект
DevOps
25 апр. 2024, в 16:08
100000 руб./за проект
Ещё заказы