Чистый код. Приемы написания красивого и понятного кода

Немного обо мне
В 1С с 2003 года. Со времен 7.7
Работал в франчайзи и в компаниях-пользователях 1С, на маленьких внедрениях и в федеральных компаниях.
Прошел через разные роли: внедренец, программист, аналитик, руководитель проектов, тимлид
Сейчас разработчик 1С в компании Автомакон (г.Москва) на проекте "ВкусВилл": сеть магазинов здорового питания, 1300 магазинов в разных городах и странах.
Ведущий консультант в компании Автоматизация (г.Омск)
Живу в Омске.

О чем доклад?

Книги

Для кого мы пишем код?

Что делает этот код?

А теперь?
Что делает этот код?

Что такое чистый код?
Элегантный, понятный
Приятно читать
Хорошо решает одну задачу
Не содержит дублирования
Четко выражает все концепции архитектуры
Предсказуемый
Выглядит так, словно его автор над ним хорошо потрудился

Приемы написания чистого и понятного кода

Как называть переменные, процедуры и функции
Имена должны передавать намерения программиста
Имя переменной, процедуры или функции должно отвечать на все вопросы:
Почему эта переменная существует
Что она делает
Как она используется

Как называть переменные, процедуры и функции?

Как называть переменные, процедуры и функции

3 принципа сразу
Компактные процедуры и функции
Один уровень абстракции на одну процедуру и функцию
Исключение дублирования

3 принципа

3 принципа

3 принципа

Магические числа

Магические числа

Магические числа

Хорошие и плохие
комментарии
Лучший комментарий – который вы не написали
Комментарий – это всегда костыль нашему неумению более выразительно выразить наше намерение
Частая причина написания комментария – сложный код
Бывают полезные комментарии (не часто)
Закоментированный код…

Хорошие и плохие
комментарии

Форматирование
и оформление кода
Смотрите как типовых:
Отделяют мысли пустыми строками
Называют имена в CamelCase
Делают отступы Если, Пока, Попытка…
Объединяют функции по смыслу в Области
Делайте также.

Как написать хороший
чистый код?

Как написать хороший
чистый код?