Правила хорошего кода

рубрики: Начинающим | Дата: 28 января, 2014

Так как в любой конфигурации 1С достаточно большой объем кода, очень часто бывает, что разработкой занимается группа программистов. И очень важно писать читабельный код, чтобы облегчить задачу вашим коллегам в будущем, когда они будут изучать ваше творчество. Да и самим вам спустя несколько месяцев будет гораздо проще вспомнить с какой же целью вы писали эти буквы.
Предлагаю несколько правил:

• Давайте понятные названия переменным.
  Как правило из названия переменной должно быть понятно ее функциональное назначение. Не стесняйтесь длинных наименований. «НоваяСтрока» воспринимается гораздо лучше чем «новстр». Тем более что волшебное сочетание клавиш ctrl+пробел поможет избежать ввода длинных переменных целиком. Достаточно набрать «нов», нажать вышеуказанное сочетание и выбрать из всплывающего списка имя вашей переменной. Если вы программировали раньше на С++ не нужно использовать в именах переменных латинские буквы. Может русские буквы в коде не так круто выглядят, но

  Для каждого СтрокаТаблицы Из ТабличнаяЧасть Цикл

  читается гораздо понятней чем

  Для каждого i Из ТаблЧ Цикл

• Всегда комментируйте свои изменения.
  Как правило пишется

  //Начало изменения ФИО
  //Старый код…
  Новый код….
  //Конец изменения ФИО

  Не удаляйте старый код. Комментирует его. Это существенно облегчит вам жизнь при обновлении конфигурации. Чтобы удобно и быстро добавлять строки «\\Начало изменения…» и «\\Конец изменения…» можно добавить шаблоны, назначить им сочетания клавиш (у меня это «++» для начала изменения и «—» для окончания. Набираю «++» жму ctrl+Q и комментарий для начала изменения готов. Можно так же в шаблоне добавить автоматическую простановку даты и времени.

• Код должен быть хорошо структурирован.Вложенные куски кода в функциях, процедурах, циклах, условиях должны иметь отступ

  Если …… Тогда

  Дата = ‘20140101’;

  Если ……. Тогда

  Дата = ТекущаяДата();

  КонецЕсли;

  КонецЕсли;

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

  Дата       = ТекущаяДата();
  Номер    = 00000099;

  Для выравнивания текста необходимо использовать табуляцию (Tab)

Эти простые правила помогут сделать ваш код легко читаемых и избежать нехороших слов в ваш адрес со стороны ваших коллег.