Как не надо писать код на C++
Краткое резюме
В статье говорится о важности использования информативных имён переменных при программировании на C++. Короткие имена могут вызвать трудности в понимании кода в будущем.
При разработке программ на C++ можно использовать разные подходы к написанию кода, однако некоторые методы могут привести к возникновению проблем в будущем. В этой статье мы дадим несколько советов, которых следует избегать, и объясним причины такого подхода.
**Именование переменных в C++**
Выбор подходящих имён для переменных — важная часть процесса программирования на любом языке, включая C++. Некоторые рекомендуют использовать короткие имена переменных, состоящие из одной или двух букв, чтобы упростить восприятие кода и уместить больше информации в одну строку. Однако такие имена могут оказаться недостаточно информативными.
Например, в простой программе «Угадай число» можно использовать переменные `g` (сокращение от `guess`) и `n` (сокращение от `number`). Хотя во время написания кода разработчик будет помнить, что означают эти переменные, через несколько месяцев ему или другому программисту может потребоваться дополнительное время, чтобы разобраться в их назначении. Это может привести к ошибкам в коде из-за неполного понимания алгоритма.
```
#include
#include
#include
int main() {
std::srand(std::time(0));
int n = std::rand() % 100 + 1;
int g = 0;
std::cout << "Угадайте число от 1 до 100: ";
while (g != n) {
std::cin >> g;
if (g < n) {
std::cout << "Слишком мало! Попробуйте снова: ";
} else if (g > n) {
std::cout << "Слишком много! Попробуйте снова: ";
} else {
std::cout << "Поздравляем! Вы угадали число!" << std::endl;
}
}
return 0;
}
```
Для улучшения читаемости кода лучше использовать более информативные имена переменных, такие как `guess` и `number`.
```
#include
#include
#include
int main() {
std::srand(std::time(0));
int number = std::rand() % 100 + 1;
int guess = 0;
std::cout << "Угадайте число от 1 до 100: ";
while (guess != number) {
std::cin >> guess;
if (guess < number) {
std::cout << "Слишком мало! Попробуйте снова: ";
} else if (guess > number) {
std::cout << "Слишком много! Попробуйте снова: ";
} else {
std::cout << "Поздравляем! Вы угадали число!" << std::endl;
}
}
return 0;
}
```
Однако в некоторых случаях короткие имена переменных могут быть уместны. Например, счётчики в небольших циклах часто называют `i`, `j`, `k`. Это общепринятая практика, и любой разработчик поймёт такой код.
```
for (int i = 0; i < 5; i++) {
cout << "Cycle: " << i << endl;
}
```