v8cs:doc-comment-use-minus¶

Использование только дефис-минуса в документирующем комментарии (doc-comment-use-minus)¶

• Категория: bsl

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

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

Неправильно¶

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

Правильно¶

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

См.¶

• Википедия: Дефис
• Википедия: Тире

Соответствие стандартам¶

Нет подтверждённых связей со стандартами.

Источник диагностики¶

• Исходная статья
• Ревизия: c8fe7932babf718c0ace3cf836a99d6a3b98d098
• Лицензия: EPL-2.0