На этой неделе команда Jetpack запустила developer.jetpack.com – справочник по коду с возможностью поиска для действий, фильтров и функций, имеющихся в плагине. Хотя Jetpack разработан для обеспечения высокой расширяемости, до сих пор разработчикам не было централизованного места для поиска документации. В справочнике представлены новые хуки, добавленные в самой последней версии, а также их можно переключать в другие версии.
Поскольку функция поиска еще не имеет автозаполнения, разработчикам нужно будет ввести точный крючок, который они хотят запросить, потому что все, что не найдено в справочнике, не вернет результатов. Поиск по общим терминам или функциям Jetpack покажет список крючков для охоты. Справочник может выиграть от разбивки на страницы или бесконечной прокрутки результатов, но его основные функции намного лучше, чем альтернатива самостоятельному поиску по базе кода. В результатах перечислены доступные параметры ловушки, и многие из них включают примеры использования.
По словам члена команды Jetpack Джереми Эрве, сайт был смоделирован по образцу кода WordPress .
«Он использует тот же синтаксический анализатор для генерации документации из базы кода плагина, и его цели схожи: предоставить некоторую информацию людям, которые хотят узнать больше о конкретном хуке или хотят знать, как настроить определенные аспекты Jetpack», – сказал Эрве. .
Эрве и другие члены команды написали много сообщений с фрагментами кода, а совсем недавно – серию «Крюк месяца», но большую часть времени при запуске нового справочника потребовалось усиление встроенной документации.
«При создании этой ссылки на код, вероятно, самым сложным было вернуться и просмотреть всю кодовую базу, чтобы добавить встроенную документацию», – сказал Эрве. «Это то, что отняло у нас больше всего времени».
Команда Jetpack планирует улучшить функцию поиска и рассматривает возможность добавления автозаполнения. Они также работают над добавлением более уникального контента и примеров кода для хуков, так как не все они еще полностью задокументированы. Этот контент продемонстрирует лучшие практики по расширению Jetpack.
«Прямо сейчас я думаю, что в первую очередь мы заинтересованы в получении отзывов от разработчиков: считают ли они это полезным, чего не хватает, что мы можем улучшить?» – спросил Эрве. Просмотр примера фильтра, такого как jetpack_open_graph_tags, дает вам представление о типе контента, который команда надеется предоставить для дополнительных ловушек. Обратная связь приветствуется в объявлении или через форму поддержки Jetpack .
