Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Возможность указывать в документирующих комментариях наборы свойств и методов (программные интерфейсы) #1694

Open
tormozit opened this issue Feb 9, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@tormozit
Copy link

tormozit commented Feb 9, 2025

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

В метод передается параметр МойСправочник типа СправочникМенеджер, который одновременно должен иметь программные интерфейсы (контракты):

  1. Набор методов, описанных в общем модуле инМенеджерСправочника
  2. Набор методов и метасвойств (определяемых в конфигурации или коде), описанных в справочнике "Шаблон"

Нужно описать такой параметр и научить анализатор кода его понимать.

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

Предлагаю описывать такой параметр так:

//Параметры:
// МойСправочник - СправочникМенеджер - ...:
// * см. инМенеджерСправочника - общий модуль
// * см. Справочники.Шаблон - справочник-шаблон

В самОм модуле, соблюдающем эти контракты, в сАмом начале модуля (хотя бы для информации) указывать комментарий
// Реализует см. инМенеджерСправочника
// Реализует см. Справочники.Шаблон

Соблюдение контрактов можно проверять новой проверкой.

Дополнительная информация

Прошу сначала утвердить синтаксис таких описаний, чтобы я мог параллельно решать аналогичную задачу в своем анализаторе кода для конфигуратора https://www.hostedredmine.com/issues/1000518

@tormozit tormozit added the enhancement New feature or request label Feb 9, 2025
@tormozit tormozit changed the title Возможность описывать в документирующих комментариях наборы свойств и методов (программные интерфейсы) через ссылки на модули и объекты Возможность описывать в документирующих комментариях наборы свойств и методов (программные интерфейсы) Feb 9, 2025
@tormozit tormozit changed the title Возможность описывать в документирующих комментариях наборы свойств и методов (программные интерфейсы) Возможность указывать в документирующих комментариях наборы свойств и методов (программные интерфейсы) Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant