Top.Mail.Ru

Как комментировать в 1С код, отдельные процедуры и запросы

Хочу поделиться своим опытом в вопросе комментирования кода и рассказать о некоторых нюансах. Новичкам должно быть полезно.

Комментарий в коде 1С

Когда пишем свой код, то вставляем комментарии в начале и в конце своих изменений. Таким образом, можно понять, кто и когда вносил изменения:

Если необходимо изменить чужой код, то внутри своего комментария комментируем чужой код и пишем свой. Таким образом понятно, что было до твоих изменений:

Комментарий новой процедуры

Часто вижу, что некоторые разработчики при создании процедур/функций оставляют комментарии «снаружи» метода:

Есть две причины, почему так не стоит делать. Первая причина: если добавить новую процедуру, то она подставляется внутрь комментария. И затем эти комментарии болтаются в модуле:

Вторая причина: при сравнении модулей в добавляемой процедуре теряется комментарий окончания:

А в нижестоящей процедуре/функции добавляется потерянный комментарий:

Если указать комментарий внутри процедуры, то при сравнении все остается на своих местах. Да, если сразу создаете несколько процедур, то нужно будет в каждой процедуре писать комментарии, но если вы пользуетесь шаблонами, по времени это займет примерно нисколько:

Комментарии в запросах

Самое интересное — комментирование текста запроса. Вариантов куча и не совсем понятно как лучше. Первый очевидный вариант, комментирование внутри текста запроса. Тут есть нюанс, если открыть конструктор запроса и сохранить, то все комментарии удаляются. Как по мне, вариант не очень удачный.

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

Есть вариант определения текста запроса отдельной функцией или функциями, в них целиком комментировать текст запроса. Таким образом, сохранены все версии текста запроса, любой из них можно открыть конструктором и посмотреть, также, при необходимости, можно выполнить сравнение текстов. На мой взгляд, это наиболее удачный вариант.

Но если текст запроса большой, то будет не совсем удобно листать. Будет лучше создать несколько функций с разными версиями текста запроса.

Надеюсь эта статья оказалась полезной. Возможно, у вас есть что добавить или поправить.

Comments

So empty here ... leave a comment!

Добавить комментарий

Sidebar