Блог компании СИТЕК

Пишем понятные статьи по 1С вам в помощь

Правила «чистого кода» в компании СИТЕК

Даже плохой код может работать. Однако если код не является «чистым», это всегда мешает развитию проекта и компании — разработчика, отнимая значительные ресурсы на его поддержку и «укрощение». Мартин Р.

Разрабатывая, внедряя, сопровождая компания СИТЕК всегда стремиться создать наиболее правильное программное решение, с высоким быстродействием, грамотной архитектурой и высокой отказоустойчивостью. На это влияет множество аспектов, но одним важнейших является программный код. Он не должен просто работать! Он должен легко читаться, быть понятен не только тому, кто его разрабатывал, быстро и эффективно выполнять свои цели, быть гибким для внесения доработок. Грамотный код будет легко сопровождать как штатной ИТ-службе, так и программистам сопровождающей организации. Предлагаю вам несколько базовых правил, используемых компанией Ситек при написании кода, которые, как я считаю, помогут поддерживать порядок в строках кода и грамотность выполнения поставленных задач. Приведу вам пример основных правил из книги Мартина Р. «Чистый код»:

1. Содержательные имена

Представьте, что программа это книга, а процедуры и функции это главы книги, строками будет являться код. Как и в книге, код должен грамотно предоставить информацию, которую он несет. Имена переменных требуют от программиста грамотных наименований иначе понять, о чем идет речь, крайне сложно. Процедуры и функции, своим именем, должны вразумительно описать свое назначение. Лучше длинное и понятное наименование, чем короткое и невразумительное.

2. Принципы форматирования кода

Читая книги, мы двигаемся глазами слева направо и сверху вниз. Главы книги идут друг за другом, не нарушая порядок повествования. В программном коде требуется использовать те же приемы. Функции и процедуры должны идти друг за другом, не нарушая порядок их выполнения. Функция, которая вызывается, должна стоять ниже вызывающей. Это поможет быстро понять, что выполняет код по первым его строкам. Абзац разделят законченные мысли в тексте. В коде эту идею следует поддерживать, отделяя пустыми строками различные концепции, и используя отступы в написании текстов.

3. Комментарии в коде

В тексте книг используются сноски, в них содержаться комментарии или ссылки на источник материала. Они встречаются довольно редко и только при серьезной необходимости. Комментарии в коде программист должен использовать минимально и эффективно. Основную повествовательную нагрузку должен нести код, ведь именно от него напрямую зависит работоспособность системы и именно код будет подвержен доработкам в будущем. Большое количество комментариев не помогут плохо написанному коду. В таком случае следует дать удобные и грамотные наименования переменным, функциям и процедурам, отформатировать код и необходимость в комментариях пропадет. Важно помнить, что хороший комментарий — тот, без которого нам удалось обойтись.

_____________________________________________________________

Автор статьи: Программист отдела сопровождения Мерзляков Андрей. Дата обновления статьи 17.08.2016

Подпишитесь на нашу рассылку
и получите еще больше статей от экспертов по 1С!

По мере публикации статей, но не чаще
одного раза в неделю.

Наши услуги по обслуживанию 1С

Хотите узнать больше или нужна консультация?

Получить ответ на вопрос Перезвоните мне

Время ответа - в течение 2 рабочих часов..

Или свяжитесь с нами любым удобным для вас способом и мы ответим на все ваши вопросы, расскажем
о возможных решениях ваших вопросов и задач
+7 (3412) 956-801