Чистый код презентация

Зачем нужен чистый код?

Несколько фактов о разработке

Несколько фактов о разработке
Над чтением кода мы проводим в 10 раз больше времени, чем над его написанием
Чем больше загрязняется наш код, тем больше мы теряем в производительности
время
производительность

Что такое чистый код?

Чистый код
Нет конкретного определения «Чистого кода». Не во всех средах
программирования есть всеми признанный
(«единственно верный») кодекс аккуратности,
иногда его просто нет или существует несколько
конкурирующих.

Признаки плохого кода
Дублирование кода;
Длинный метод;
Большой класс;
Длинный список параметров;
Избыточные временные переменные;
Классы данных.

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

Используйте понятные идентификаторы
team.Select( p => p.Age > 18);
VS
teams.Select(team => team.Age > 18);

Пишите краткие и понятные комментарии
public void msg(string s)
{
Console.WriteLine("Вывод из объекта tst1: " + s);
}
///
/// Выводит строку текста
///
///
Строка текста для вывода
public void msg(string s)
{
Console.WriteLine("Вывод из объекта tst1: " + s);
}
VS

Используйте комментарии без фанатизма
Написание комментариев для себя (пример: /* Закончу как-нибудь потом... */).
Ни о чём не говорящие выражения (e.g. /* Это очередная математическая функция. */).
Также иногда люди не уверены в какой-то функциональности и просто комментируют фрагмент кода.

Используйте стандарты именования переменных и функций

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

Рефакторинг

Когда рефакторить?
Правило трёх:
Делая что-то в первый раз, вы просто это делаете.
Делая что-то аналогичное во второй раз, вы морщитесь от необходимости повторения, но все-таки повторяете то же самое.
Делая что-то похожее в третий раз, вы начинаете рефакторинг.
Когда делаете новую фичу
Когда исправляете баги
Во время код-ревью

Как рефакторить?
Код должен стать чище.
В процессе рефакторинга не создаётся новая функциональность.
Все существующие тесты должны успешно проходить.

Утилиты

Утилиты