Приветствую читателя! В этой статье будем интегрировать документацию 1С-Битрикс прямо в IDE PhpStorm c помощью подключения внешней библиотеки bxApiDocs.
При разработке сайтов на 1С-Битрикс приходится часто обращаться к API системы на офф сайте компании — http://dev.1c-bitrix.ru/api_help/. Все бы хорошо, но переход на сайт, поиск нужного метода по огромной документации занимает драгоценное время. Было бы круто иметь документацию прямо в среде разработки! Такая возможность есть, давайте перейдем к ее настройке!
bxApiDocs
Для начала нам понадобится скачать bxApiDocs. Это проект, в котором собрана последняя версия папки modules вместе с интегрированной в нее документацией. Над большинством из методов в файлах данной папки присутствует PHPDoc-комментарий, который дублирует описание метода из документации на сайте.
А так, как PhpStorm умеет индексировать такие комментарии — мы автоматически получаем готовую документацию в каждом файле проекта для большинства методов BitrixFramework лишь поставив курсор на нужную функцию и нажав Ctrl+Q. Действительно впечатляет!
Переходите на страницу bxApiDocs на GitHub’e и скачивайте проект себе на компьютер — https://github.com/matiaspub/bxApiDocs
Распакуйте архив, рекомендую для удобства держать это все в папке с проектами PhpStorm. Далее переходим к подключению модулей в самой IDE.
Подключение bsApiDocs в PhpStorm
Переходим в IDE, открываем проект с сайтом на Битрикс. В левой части экрана под папками проекта есть пункт External Libraries. Кликаем по нему два раза:
Появится окно:
Нажимаем на зеленый плюс для добавления новой внешней библиотеки. Ищем разархивированную папку bxApiDocs и выбираем в ней папку modules для подключения и применяем изменения:
Запустится индексация библиотеки:
Теперь при выделение какого-либо метода Битрикс в коде и нажатии Ctrl+Q мы увидим окошко с документацией по данному методу
