каждый разработчик столкнулся с ним: грязный код - тот вид кода, который выглядит так, как будто он был написан в спешке, посыпанный магическими числами, дублированными блоками и загадочными именами переменных. Это работает ... едва. Но поддерживать это? Это кошмар.

]

Если вы когда -либо пробормотали под своим дыханием, рефактируя чужой код (или даже свой собственный), эта статья для вас. Вот несколько простых правил, чтобы сохранить ваш код чистым, читаемым и будущим.

]

что такое грязный код?
] Грязный код - это код, который:

]

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

]

это часто происходит, когда разработчики:

]

]
1. работают в сжатые сроки.
]
2. обзоры скипного кода.
3. не следуйте передовым практикам или стандартам.
]

]

почему грязный код является проблемой?

]

]
• трудно отладить: Исправление одной ошибки может представить пять других.
]
• дорогой для поддержания: плохо написанный код занимает больше времени для улучшения.
]
• команда путаница: новые разработчики проводят дополнительные часы, просто пытаясь понять, что происходит. Грязный код может выполнить работу сегодня, но это бомба для вашей команды и будущего.
]

]

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

]

1. Следуйте принципу единой ответственности (SRP)
] Каждая функция, метод или класс должны делать только одну вещь. Если вы обнаружите, что пишете методы со слишком большим количеством обязанностей, разбейте их на более мелкие единицы.

❌ Плохой пример:

]

def process_user_data(user):
    user['age'] = user['age']   1  
    db.save(user)  
    print(f"User {user['name']} updated")  

]

✅ Хороший пример:

]

def update_user_age(user):
    user['age']  = 1  

def save_user_to_db(user):
    db.save(user)  

def log_user_update(user):
    print(f"User {user['name']} updated")  

]

каждая функция теперь имеет одну четкую задачу, упрощая код для тестирования и изменения.

]

2. Избегайте магических чисел и строк
] Жесткие значения («Магические числа») делают код нечитаемым и трудным для поддержания. Вместо этого используйте константы.

]

❌ Плохой пример:

]

if (statusCode === 404) {  
    console.log("Not Found");  
}

]

✅ Хороший пример:

]

const NOT_FOUND = 404;

if (statusCode === NOT_FOUND) {  
    console.log("Not Found");  
}

]

постоянный not_found является самоочевидным, что облегчает чтение вашего кода.

3. Напишите описательную переменную и имена функций
] Ваши имена переменных должны отражать то, что они представляют. Избегайте сокращений и загадочных имен.

]

❌ Плохой пример:

]

int a = 5;  
String s = "John";  

]

✅ Хороший пример:

]

int userAge = 5;  
String userName = "John";  

]

то же самое относится к функциям. Избегайте смутных имен, таких как Dostuff () или Process (). Быть конкретным.

]

4. Сухо (не повторяйте себя)
] Если вы копируете и вставляете код, вы делаете это неправильно. Дублированный код делает исправление ошибки кошмаром. Аннотация повторяющаяся логика в функции или классы.

]

❌ Плохой пример:

]

print("Welcome, John")  
print("Welcome, Mary")  

]

✅ Хороший пример:

]

def greet_user(name):
    print(f"Welcome, {name}")  

greet_user("John")  
greet_user("Mary")  

]

5. Держите свои функции короткими
Если ваша функция длиннее 20-30 строк, она делает слишком много. Разбить его на более мелкие, многоразовые функции.

]

длинные функции затрудняют понимание и проверку конкретного поведения.

]

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

]

❌ Плохой пример:

]

// Increment the counter by 1  
counter = counter   1;  

]

✅ Хороший пример:
Если ваш код ясен, никаких комментариев не требуется:
]

]

counter  = 1;  

]

Используйте комментарии для того, чтобы разъяснить, почему было принято определенное решение, а не то, что делает код.

7. Формат и организуйте свой код

]

]
Используйте правильное отступление.
• ]
код, связанный с группой вместе. Хорошее форматирование делает код чистым и читабельным без каких -либо дополнительных усилий.
• ]
]

Mindset разработчика: написать код для людей ] Код не написан только для машин; Это написано и для людей - ваши товарищи по команде, будущие сопровождающие или даже самих себя через шесть месяцев. Когда вы пишете чистый код:
]

]

вы уменьшаете умственную нагрузку для других.
• ]
вы облегчаете отладку, расширение и улучшение.
• ]
вы выглядите как профессиональный разработчик, который ценит качество.
• ]
]

final Monds ] Избегать грязного кода не сложно - он просто требует дисциплины. Следуйте этим простым правилам:
]

]

придерживаться принципа единственной ответственности.
1. ]
Избегайте магических чисел.
используйте Clear, описательные имена.
3. ]
высушить повторяющийся код.
4. ]
сохранить функции коротким.
используйте комментарии мудро.
6. ]
последовательно форматируйте свой код.
7. ]
]

чистый код не о совершенстве; Речь идет о том, чтобы сделать вашу работу, поддерживаемой и понятной. Ваше будущее - и ваша команда - спасибо.

]

теперь идите и рефактор тот грязный код, который вы игнорировали! ?

]

] ]