Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.65 KB

doc-comment-use-minus.md

File metadata and controls

33 lines (24 loc) · 1.65 KB

Использование только дефис-минуса в документирующем комментарии

В описании в модели документирующего комментария необходимо использовать только символ дефис-минус вместо обычного дефиса или различных вариантов тире.

Эта проверка анализирует неправильные "минусы" в первом текстовом элементе в описании, идущем после декларации поля, чтобы найти возможное неправильное построение модели документирующего комментария.

Неправильно

// Параметры:
//  Параметры – Структура - первый это "среднее тире" а второй это "минус":
//  * Ключ1 - Число ⸺ некорректное длинное тире
Процедура NonComplaint(Параметры) Экспорт
	// пустая
КонецПроцедуры

Правильно

// Параметры:
//  Параметры - Структура - оба использованы минусы:
//  * Ключ1 - Число - использованы корректные дефис-минусы
Процедура Complaint(Параметры) Экспорт
	// пустая
КонецПроцедуры

См.