Все написанное ниже является моим мнением, и я буду рад критике и обсуждениям.
1. Обычный комментарий
// infostart Начало 15.11.2015
НоваяПеременная = СтараяПеременная + 1;
// infostart Окончание 15.11.2015
Узнаете? Обычный комментарий обычного программиста 1С.
Давайте представим, что этот комментарий Вы видите через два года или его вообще писали не Вы.
Что мы из него можем понять? Кто-то что-то изменил. Разве этого достаточно?
Как можно улучшить?
Когда мы что-то изменяем в типовой конфигурации, то мы изменяем это для какой-то конкретной цели. Эту цель и следует указывать в комментариях. Такой комментарий позволит вспомнить, зачем и почему было сделано такое изменение. Но если с целью всё плохо, напишите, для кого Вы делали это изменение. В дальнейшем цель можно будет уточнить у этого человека.
2. Было/стало
А = А + В;
// infostart Начало
// Было B = A - 5:
// Стало
В = А - 4;
Такие комментарии используются для того, чтобы восстановить типовой алгоритм. Но по факту мы ухудшаем наглядность кода. А при сравнении и объединении конфигураций отображаются три строки, вместо одной.
Как можно улучшить?
С восстановлением типового алгоритма гораздо лучше справляется механизм сравнения и объединения с конфигурацией поставщика. Поэтому лучше отказаться от таких комментариев, или хотя бы писать их в одну строчку:
А = А + В;
В = А - 4; // infostart Было B = A - 5:
3. Идентификация новых процедур
Такие комментарии используются для обрамления новых процедур и функций. Обычно это выглядит так:
Вроде всё в порядке, и так нам легче ориентироваться в модуле. Но есть один неприятный момент - при сравнении и объединении будут отображаться лишние изменения в разделе основной программы:
Это доставляет определенные неудобства, если измененных объектов в конфигурации много.
Как можно улучшить?
Для добавления новых процедур лучше использовать другие способы идентификации, например, префикс перед названием процедуры:
Процедура Infostart_НоваяПроцедура(Параметр1)
Параметр1 = Параметр1 + 1
КонецПроцедуры
Напоследок еще один способ использования комментариев
В своих проектах наша команда использовала комментарии, как уникальные идентификаторы для изменения конфигураций. Эти идентификаторы служат связью технического задания с кодом конфигурации.
Работает это следующим образом:
- Задаче присваивается уникальный идентификатор (например, ТЗ01_НДС).
- Во всех местах, где вносятся изменения, в комментариях указывается данный идентификатор.
Это позволяет легко и быстро найти и изменить доработанные механизмы и ничего не забыть при этом.
Работает это следующим образом:
- Открываем ТЗ и находим уникальный идентификатор.
- Глобальным поиском находим все места, где были изменения.
- Дорабатываем.
Можно использовать идентификаторы и наоборот. Например, изучаете код, но не можете понять, для чего было сделано изменение. По уникальному идентификатору ищем в ТЗ необходимую информацию.
На этом все. Буду рад, если Вы поделитесь своими способами использования комментариев.
Вступайте в нашу телеграмм-группу Инфостарт
