Базовое форматирование кода в C++

Хорошее форматирование кода важно для обеспечения читаемости и понимания вашего кода другими программистами (и вами в будущем). Давайте рассмотрим основные правила форматирования кода в C++.

1. Отступы:

Используйте отступы для выделения блоков кода. Обычно используются четыре пробела для каждого уровня отступа. Например:

#include <iostream>

int main() {
    // Отступы для выделения блока кода
    if (true) {
        std::cout << "Условие выполняется." << std::endl;
    } else {
        std::cout << "Условие не выполняется." << std::endl;
    }

    // Отступы для вложенных блоков
    for (int i = 0; i < 5; ++i) {
        std::cout << "Итерация " << i << std::endl;
    }

    return 0;
}

2. Пустые строки:

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

#include <iostream>

void function1() {
    // Логическое разделение блоков кода
    std::cout << "Функция 1." << std::endl;
}

void function2() {
    std::cout << "Функция 2." << std::endl;
}

int main() {
    function1();

    // Пустая строка для логического разделения
    function2();

    return 0;
}

3. Пробелы:

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

#include <iostream>

int main() {
    int x = 5;  // Пробелы вокруг оператора присваивания

    for (int i = 0; i < 5; ++i) {  // Пробелы после запятой
        std::cout << "Итерация " << i << std::endl;
    }

    return 0;
}

4. Длина строки:

Стремитесь к тому, чтобы строки кода не были слишком длинными. Рекомендуется ограничивать длину строки примерно 80-120 символами. Это повышает читаемость, особенно при работе с несколькими окнами редактора.

5. Комментарии:

Используйте комментарии для пояснения сложных участков кода. Они должны быть ясными и описывать "почему" код делает то, что он делает, а не "что" делает код (для этого используются хорошие имена переменных и функций).

#include <iostream>

int main() {
    int x = 5;  // Комментарий пояснения

    // Хорошее название переменной делает комментарий избыточным
    int numberOfIterations = 10;

    return 0;
}

6. Правила именования:

Следуйте правилам именования, таким как CamelCase для имен функций и переменных, чтобы сделать код более читаемым.

#include <iostream>

void calculateTotalAmount() {  // CamelCase для имен функций
    int numberOfItems = 10;  // CamelCase для имен переменных
    std::cout << "Total amount: " << numberOfItems * 2 << std::endl;
}

int main() {
    calculateTotalAmount();

    return 0;
}

Соблюдение этих основных правил форматирования делает код более читаемым и понятным для вас и других разработчиков.