Skip to content

Несоответствие терминов в разделе Components: VARIABLE_ALIASES описан для "контроллера" вместо "компонента" #70

@Trionikl

Description

@Trionikl

Описание проблемы

Терминологическая нестыковка в описании параметра VARIABLE_ALIASES: используется термин "контроллер" в контексте, где речь идет о компонентах, что создает путаницу для разработчиков.

Локация

  • URL: https://docs.1c-bitrix.ru/pages/framework/components.html
  • Раздел: Описание параметра VARIABLE_ALIASES
  • Текущая формулировка: "описывает переменные, которые контроллер может получать из HTTP-запроса"

Проблема

В документации по компонентам (раздел components.html) используется термин "контроллер", хотя:

  1. Весь остальной контекст посвящен компонентам (не контроллерам)
  2. В других разделах того же описания VARIABLE_ALIASES используется термин "компонент" (см. раздел про .parameters.php)
  3. Это сбивает с толку разработчиков, изучающих архитектуру D7, так как создается впечатление, что VARIABLE_ALIASES относится к какому-то отдельному контроллеру, а не к комплексному компоненту

Предлагаемое решение

Заменить на единообразную терминологию:

Вариант 1 (точный):
> "описывает переменные, которые комплексный компонент (контроллер) может получать из HTTP-запроса"

Вариант 2 (упрощенный):
> "описывает переменные, которые компонент может получать из HTTP-запроса"

Дополнительный контекст

Согласно архитектуре MVC в Bitrix Framework, комплексный компонент действительно выполняет роль контроллера, но для единообразия документации лучше использовать термин "компонент" или явно уточнить "комплексный компонент (контроллер)", чтобы читатель понимал, что речь идет о component.php/class.php комплексного компонента, а не об отдельном классе-контроллере.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions