[NEW] Бессмысленный комментарий

[theshadowco]

Описание проблемы, ошибки, которую надо диагностировать

Бессмысленные комментарий захламляют код, снижают его понимание.

Ссылка на источник, подтверждающее нарушение либо обоснование наличия проблемы

нет, но

• https://habr.com/ru/post/108985/
• https://tproger.ru/articles/comments-in-code/

Параметры диагностики

Тип Статья на русском

• [ ] :ant: Ошибка
• [ ] :cop: Уязвимость
• [x] :poop: Качество кода
• [ ] :trollface: Другое

Важность Статья на русском

• [ ] :broken_heart: Блокирующая / Blocker
• [ ] :heart: Критическая / Critical
• [ ] :yellow_heart: Важная / Major
• [ ] :blue_heart: Незначительная / Minor
• [x] :green_heart: Информационная / Info
• [ ] :revolving_hearts: Другое

Тэги Статья на русском

• [ ] STANDARD - "Нарушение стандартов 1С"
• [ ] LOCKINOS - "Не будет работать в другой ОС"
• [ ] SQL - "Проблема с запросом"
• [ ] PERFORMANCE - "Проблема производительности"
• [ ] BRAINOVERLOAD - "Непонятный код"
• [x] BADPRACTICE - "Плохая практика программирования"
• [ ] CLUMSY - "Излишние действия"
• [ ] DESIGN - "Ошибка в проектировании"
• [ ] SUSPICIOUS - "Подозрительный код"
• [ ] UNPREDICTABLE - "Непредсказуемо работающий код"
• [ ] DEPRECATED - "Устаревшая функциональность"
• [ ] ERROR - "Ошибочная конструкция"

Время на исправление (минут)

1

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

Примеры (лично мне не нравятся)

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

// 

///

Комментарии из прошлых эпох

// ++ Разработчик
// ++ 01.01.2001 Разработчик TASK4
// ++ 01.01.2001 TASK5
// -- Разработчик

Псевдоразделители

// ++ 
// --

[nixel2007]

Кажется, что это можно ловить диагностикой на служебные тэги, по регулярке.

[zeegin]

https://its.1c.ru/db/v8std#content:456 пп. 3, 7.1, 7.2, 7.3 https://its.1c.ru/db/v8std#content:453 п. 4

[theshadowco]

Служебные тэги это несколько иное

[artbear]

Еще пример бессмысленного комментария - комментарий в конце метода с именем самого метода

Функция ИмяСобытияДляЖурнала()

	Возврат "Журналируемые события";

КонецФункции // ИмяСобытияДляЖурнала()

[nixel2007]

а вот тут не уверен, что он бессмысленный.

[artbear]

@nixel2007 коммент с именем функции почти бесполезен, даже в Конфигураторе можно увидеть имя текущей процедуры в спец.панели, не говоря уж про VSC и EDT