+7 495 008 8452
  • Загрузка
Выберите ваш цвет
Если у вас возникли какие либо вопросы которые вы не смогли решить по нашим публикациям самостоятельно,
то ждем ваше обращение в нашей службе тех поддержки.


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

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

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


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

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

1.jpg

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

Подключение bsApiDocs в PhpStorm

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

Кликаем по нему два раза:

3.jpg

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

4.jpg

Запустится индексация библиотеки:

5.jpg

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

6.jpg

Оригинал - http://rodion-web.pp.ua/documentacia-...-phpstorm/

 

 

Источник: https://dev.1c-bitrix.ru/community/webdev/user/156743/blog/9382/

Назад в раздел

Подписаться на новые материалы раздела:
Загрузка...