Документация 1С-Битрикс в IDE PhpStorm

В этой статье будем интегрировать документацию 1С-Битрикс прямо в IDE PhpStorm c помощью подключения внешней библиотеки bxApiDocs.

При разработке сайтов на 1С-Битрикс приходится часто обращаться к API системы на офф сайте компании — http://dev.1c-bitrix.ru/api_help/. Все бы хорошо, но переход на сайт, поиск нужного метода по огромной документации занимает драгоценное время. Было бы круто иметь документацию прямо в среде разработки! Такая возможность есть, давайте перейдем к ее настройке!

Для начала нам понадобится скачать bxApiDocs. Это проект энтузиастов hipot studio (ex wexpert), которые смогли собрать последнюю версию «битриксовой» папки modules и интегрировать в нее документацию. Над каждым методом в файлах данной папки присутствует PHPDoc-комментарий, который дублирует описание метода из документации на сайте.

А так, как наша IDE умеет индексировать такие комментарии — мы автоматически получаем готовую документацию в каждом файле проекта для большинства методов BitrixFramework лишь поставив курсор на нужную функцию и нажав Ctrl+Q. Действительно впечатляет!

Переходите на страницу bxApiDocs на GitHub’e и скачивайте проект себе на компьютер -  https://github.com/hipot-studio/bxApiDocs

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

Переходим в IDE, открываем проект с сайтом на Битрикс. В левой части экрана под папками проекта есть пункт External Libraries:

Нажимаем на зеленый плюсик для добавления новой внешней библиотеки. Ищем разархивированную папку bxApiDocs и выбираем в ней папку modules для подключения и применяем изменения:

Теперь при выделение какого-либо «битриксового» метода в коде и нажатии Ctrl+Q мы увидим окошко с документацией по данному методу