bsl-language-server icon indicating copy to clipboard operation
bsl-language-server copied to clipboard

[FP] Отсутствует описание возвращаемого значения

Open Daabramov opened this issue 3 years ago • 0 comments

Диагностика

MissingReturnedValueDescription

Версия

Sonar Plugin 1.11.0

Описание ложного срабатывания диагностики

Если для части полей возвращаемой структуры отсутствует описание, то выходит ошибка незаполненного описания возвращаемого значения

Пример кода

// Новые параметры отбора.
// Возвращаемое значение:
//  Структура - Новые параметры отбора:
// * Важность - Массив из ПеречислениеСсылка.ВариантыВажностиЗадачи
// * Автор - Массив из СправочникСсылка.Пользователи
// * СостояниеБизнесПроцесса - Массив из ПеречислениеСсылка.СостоянияБизнесПроцессов
// * ФактическийИсполнитель - Массив из СправочникСсылка.Пользователи - Используется отбор по реквизиту
// * Исполнитель - Массив из СправочникСсылка.Пользователи - В этом случае будет использоваться поиск с учетом ролей исполнителей
// * Предмет - Массив из ДокументСсылка.Основание
// * РольИсполнителя - Массив из СправочникСсылка.РолиИсполнителей
// * ОбъектАдресации - Массив из Характеристика.ОбъектыАдресацииЗадач
// * Выполнена - Неопределено,Булево
// * Активные - Неопределено,Булево
// * Описание - Строка - шаблон описания задачи, отбирается черезе ПОДОБНО %текст%
// * ОтборПоБизнесПроцессу - Булево - Признак использования отбора по свойству БизнесПроцесс
// * БизнесПроцесс - Массив из см. ОпределяемыйТип.БизнесПроцесс
Функция НовыеПараметрыОтбора() Экспорт

	Отбор = Новый Структура();
	Отбор.Вставить("Важность", Новый Массив());
	Отбор.Вставить("Автор", Новый Массив());
	Отбор.Вставить("СостояниеБизнесПроцесса", Новый Массив());
	Отбор.Вставить("Исполнитель", Новый Массив());
	Отбор.Вставить("ФактическийИсполнитель", Новый Массив());
	Отбор.Вставить("РольИсполнителя", Новый Массив());
	Отбор.Вставить("ОбъектАдресации", Новый Массив());
	Отбор.Вставить("Предмет", Новый Массив());
	Отбор.Вставить("Выполнена", Неопределено);
	Отбор.Вставить("Описание", "");
	Отбор.Вставить("ОтборПоБизнесПроцессу", Ложь);
	Отбор.Вставить("БизнесПроцесс", Новый Массив());
	Отбор.Вставить("Активные", Неопределено);
	
	Возврат Отбор;
КонецФункции

Скриншоты

image

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

По стандарту https://its.1c.ru/db/v8std#content:641:hdoc допускается опускание описания полей структур и т.п.

Daabramov avatar Jul 18 '22 14:07 Daabramov