TODO, FIXME, XXX

Бывает когда код, фрагмент в документации или фрагмент чего либо (если all as code) нужно пометить каким-то образом для дальнейшего использования: оптимизация или какой-то прочий улучшайзинг.

Что мы обычно делаем (И/ИЛИ):
🔸Пишем какой-то комментарии к этому фрагменту // тут надо все переделать или отрефакторить
🔸На выделенный фрагмент создаем issues в любимом task tracker с содержимым задачи
🔸Делаем codemarks с помощью инструментов Code-Review (аля CodeStream, Gitlab, Gitlab, Upsourse, Stash)

Все варианты довольно жизнеспособны и актуальность их применение зависит от производственного процесса, но сегодня хотелось бы особенно проговорить вариант с комментариями, а точнее применение специальных тегов/токенов. Уверен, что большая часть конечно же знает о чем речь, но тем не менее в "1С мире" почему-то этот неформальный стандарт часто игнорируется (с приходом 1С:EDT, 1С: Исполнитель картинка будет меняться в лучшую сторону).

Так вот, можно и нужно использовать теги в комментариях. Это поможет с индексированием таких пометок. Впоследствии их можно модерировать с помощь функционала "Задачи" в 1С:EDT, можно с помощью сторонних расширений для VS Code, ортодоксы могут и unix grep заюзать. А кто-то и quality gate настраивает, опираясь на метрики наличия тегированных комментариев (в BSL Language Server соответствующая диагностика имеется). А еще многие IDE умеют подсвечивать комментарий с наличием токенов.

Вот несколько примеров оформления. Пользуйтесь, пожалуйста)

// TODO: дописать обработку исключений
// FIXME: убрать обращение через .
// XXX: тут что-то не работает

Всем отличной пятницы и классных выходных)

P.S. Помните о существовании стандарта (п.7.3) - Между символами комментария "//" и текстом комментария должен быть пробел.
P.P.S. При добавлении обработчика событий 1C:EDT автоматически добавляет комментарий //TODO: Вставить содержимое обработчика (без пробела). Если кто-то знает как это исправить: смириться или зарегать баг - welcome в комменатрии