Когда выгружаете реализацию крюка в другую функцию, какая функция должна быть документирована как «Реализует ...»?

Это (возможно, очень простой) вопрос, связанный с документами.

Пример:

_menu_block_block_configure - DrupalContrib

Обратите внимание на документы: «Осуществляет hook_block_configure ().»

Сначала он отбросил меня, чтобы увидеть внутреннюю функцию (с префиксом нижнего подчеркивания), задокументированную как реализация перехвата, но если фактическая работа выполняется здесь, есть смысл.

Мой вопрос: это правильный способ документировать его?

6 голосов | спросил othermachines 14 PM00000070000003731 2015, 19:56:37

1 ответ


5

TL; DR: Да, это хорошо и широко распространено!

Он может выглядеть как неортодоксальный, но он просто выгружает основную часть реализации hook для включения, чтобы сохранить основной файл .module меньше. Вот где это происходит: menu_block.module (просмотреть исходный код внизу).

Многие другие вкладки тоже делают это, например: Display Suite (см. строку 48 и далее), и я уверен, что Мнения и куча других тоже.

ответил Alex Weber 14 PM00000080000005831 2015, 20:39:58

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132