-
Notifications
You must be signed in to change notification settings - Fork 18
Description
Описание проблемы
Терминологическая нестыковка в описании параметра VARIABLE_ALIASES: используется термин "контроллер" в контексте, где речь идет о компонентах, что создает путаницу для разработчиков.
Локация
- URL: https://docs.1c-bitrix.ru/pages/framework/components.html
- Раздел: Описание параметра
VARIABLE_ALIASES - Текущая формулировка: "описывает переменные, которые контроллер может получать из HTTP-запроса"
Проблема
В документации по компонентам (раздел components.html) используется термин "контроллер", хотя:
- Весь остальной контекст посвящен компонентам (не контроллерам)
- В других разделах того же описания
VARIABLE_ALIASESиспользуется термин "компонент" (см. раздел про.parameters.php) - Это сбивает с толку разработчиков, изучающих архитектуру D7, так как создается впечатление, что
VARIABLE_ALIASESотносится к какому-то отдельному контроллеру, а не к комплексному компоненту
Предлагаемое решение
Заменить на единообразную терминологию:
Вариант 1 (точный):
> "описывает переменные, которые комплексный компонент (контроллер) может получать из HTTP-запроса"
Вариант 2 (упрощенный):
> "описывает переменные, которые компонент может получать из HTTP-запроса"
Дополнительный контекст
Согласно архитектуре MVC в Bitrix Framework, комплексный компонент действительно выполняет роль контроллера, но для единообразия документации лучше использовать термин "компонент" или явно уточнить "комплексный компонент (контроллер)", чтобы читатель понимал, что речь идет о component.php/class.php комплексного компонента, а не об отдельном классе-контроллере.