Всё чаще звучат призывы писать код, который соответствует утвержденным стандартам вендора. На проектах внедряют проверки на соответствие кода стандартам, например, SonarQube. Вопрос заинтересовал меня, и я решил изучить более глубоко. Прошел курс от вендора и постарался кратко, «без воды», изложить важные моменты.
В статью вошли темы по структуре модулей, модули, в которых следует размещать код, наименования процедур, функций и их параметров и др. Вопросы по запросам, событиям модулей объектов войдут во вторую часть.
Для новичков рекомендую первоначально заппомнить самые простые правила — наименования переменных, функций и процедур, затем разобраться с параметрами функций/ процедур и структурой и т. д.
«Никто не обнимет необъятного», — Козьма Прутков.
Поначалу относился к стандарту, как к простым понятным правилам, которые можно прочитать по диагонали один раз и твой код будет соответствовать. Но прочитать, запомнить стандарт и даже писать код, соответствующий стандарту про разное. У каждого разработчика вырабатывается привычка как размечать код, как называть переменные, функции и, если эта привычка не соответствует стандарту — то, для изменения её требуется приложить усилия.
Мне сложно привыкнуть к правильному написанию условных операций — «Не», вместо «НЕ» и «Или» вместо «ИЛИ». Причем нужно учесть, что в запросах эти же условные операции пишутся «НЕ» и «ИЛИ». Также проверяю себя, чтобы функции и процедуры были распределены правильно по областям модуля. Благодаря этому получаю высокие оценки на код-ревью.
Информацию постарался представить в виде памятки, используя которую можно быстро освежить в памяти нужную информацию, не пересматривая все видео урока. Надеюсь, что вы внимательно прочитаете стандарты полностью. Финальное пожелание — возвращайтесь периодически к текстам стандартов, проверяйте себя.
