Комментирование кода –  это внесение пояснений в тест модулей, которые не является обязательными и не влияют на алгоритм (не исполняются)

Производится только с помощью последовательности “//“, при этом комментарием считается все, что находится после.

Пример комментария:

Перем ЭтоНеКомментарий; // А это уже комментарий //Это тоже комментарий

Доступны только однострочные комментарии, синтаксиса для  обозначения начала и окончания многострочных комментариев нет.

Возможно использование в подряд идущих комментариев:

//Это первая строка комментария
//Это вторая строка комментария
//Строка комментария после пустой строки 
// Перем А;//Эта переменная не объявится

Горячие клавиши

ctrl + / – добавить комментарий в выделенных строках;

ctrl + shift + / – удалить комментарий в выделенных строках

В данном случае комментарий, конечно, не удаляется, а удаляется символы комментирования из каждой строк выделенного блока

Установка и снятие комментария интерактивно по кнопкам:

Выделяется код и нажимаются на панели “Модуль” соответствующие кнопки “Добавить комментарий” и снять “Комментарий”

 

Снятие комментария

или более длинный путь:

Меню “Текст\Блок\Добавить комментарий” или “Текст\Блок\Удалить комментарий

Установка комментарие длинный путь

 

Должен заметить, что текст комментариев –  только для программистов, пользователь его не увидит, и служит для:

  • описания сложных участков кода или алгоритма
  • логического отделения блоков непрерывного кода, в данном случае поле “\\” ничего не пишется
  • описания функций и процедур
  • выделения изменений в код типовых конфигураций, при обновлении упростит разбор
  • описания ситуации внесения изменений, даты
  • отметка ошибочного или сомнительного кода, в процесcе code review (анализа  качества кода 1С)

Правила комментирования кода действуют и для языка запросов 1С, но важно отметить, что  при использовании Конструктора запроса(визуального средства разработки запроса к базе), комментарии удаляются полностью, а не снимается признак “\\”.

Среда разработки может автоматически сворачивать комментарии, для удобства восприятия

Настроить это можно в меню “Сервис\Параметры” далее вкладки “Модули\Группировка”

Сворачивание комментариев

Там же на вкладке “Модули\Редактирование” возможно отключить или поменять цвет выделения комментария с зеленого (по умолчанию)

Модули Редактирование

Если вы ранее не программировали и у вас нет определенных привычек к цвету текста, то лучше не менять, т.к. не всегда вы будете работать на своем компьютере и лучше привыкнуть к единому стилю, но тут решать вам.

 

Рекламные объявления содержат единственные правдивые сведения, которые можно найти в газетах.

— Т. Джефферсон