[MOD] MissingReturnedValueDescription - Поддержка описания возвращаемого значения в формате "см. ПутьКФункции."

[potoyalo]

Диагностика

Отсутствует описание возвращаемого значения функции (MissingReturnedValueDescription)

Описание предлагаемых изменений

Необходимо, чтобы диагностика понимала описание возвращаемого значения в формате см. ПутьКФункции, то есть указание ссылки на тип вместо самого типа. Пример:

// Возвращаемое значение:
//  См. НовыйОбъектДанных
Функция ОбработкаОбъекта(Объект) Экспорт

В стандарте такой формат разрешен и описан для параметров (см. п. 5.2.2, 5.2.6). Для возвращаемых значений подробностей нет, но логично, что работать должно аналогично с параметрами. Для возвращаемых значений такой формат описан в документации EDT по типизации кода: например см. раздел Возможности типизирующих документирующих комментариев.

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

Обсуждение вопроса в чате BSL LS.

[potoyalo]

Уточнение: диагностика рапортует замечание в случае указания точки после описания типа.

// Так орёт:
// Возвращаемое значение:
//  См. НовыйОбъектДанных.
Функция ОбработкаОбъекта(Объект) Экспорт

// Так норм:
// Возвращаемое значение:
//  См. НовыйОбъектДанных
Функция ОбработкаОбъекта(Объект) Экспорт

Кажется, указание точки в конце описаний не регламентируется стандартами. Хотя из примеров документации видно, что точка всегда ставится после указания описаний метода/параметра/возвр.значения и всегда не ставится после указания типа параметра/возвр.значения. Однако, EDT спокойно относится к точке после указания типа возвращаемого значения. Было бы удобно, чтобы и BSL LS был лояльнее в этом вопросе в соответствии с поведением IDE.

[nixel2007]

cc: @theshadowco