Примери за чист код (Clean Code) - nessa456/dotnet-portfolio GitHub Wiki
Примери за чист код
Чистият код е лесен за четене и поддръжка. Ето някои добри практики:
-
Ясни и описателни имена
Вместоint d;
използвайтеint daysSinceLastUpdate;
-
Малки функции
Функциите трябва да вършат едно нещо и да са с малко редове. -
Избягвайте дублиране на код
Ако един код се повтаря, го изнесете в отделна функция. -
Използвайте коментари само когато е необходимо
Кодът трябва да е ясен сам по себе си. Коментарите да обясняват "защо", а не "как". -
Консистентен стил
Спазвайте един и същ стил за именуване, форматиране, подравняване.
Пример:
// ПЛОХО:
void p() {
int d; // брой дни
d = 5;
// ...
}
// ДОБРО:
void PrintReportForLastFiveDays() {
int daysToReport = 5;
// ...
}