Соглашения об именовании

Часть раздела Основы путешествия по C++ на Coddy — урок 12 из 74.

В программировании важно соблюдать соглашения об именовании, чтобы ваш код оставался читаемым и удобным в сопровождении. Тем не менее, существуют определенные правила и соглашения, которым следует следовать при именовании объектов в C++:

Имена могут содержать буквы, цифры и символы подчеркивания.
Имена должны начинаться с буквы или символа подчеркивания.

Имена чувствительны к регистру (myVariable и myvariable различаются).
Имена не могут быть ключевыми словами C++ (такими как int, float, if и т. д.).

В дополнение к этим правилам, существуют некоторые общепринятые соглашения об именовании, которые разработчики используют, чтобы сделать свой код более последовательным и читаемым:

camelCase — слова соединяются вместе, при этом каждое слово, начиная со второго, начинается с заглавной буквы (например, totalAmount, numberOfStudents). Обычно используется для имен переменных и функций в C++.
PascalCase — похож на camelCase, но первое слово также начинается с заглавной буквы (например, TotalAmount, MyClass). Обычно используется для имен классов в C++.

snake_case — все слова пишутся в нижнем регистре и разделяются символами подчеркивания (например, total_amount, number_of_students). Часто используется в C++ для имен файлов или в других языках, таких как Python.
SCREAMING_SNAKE_CASE — похож на snake_case, но все буквы заглавные (например, MAX_SIZE, TOTAL_AMOUNT). Обычно используется для констант и макросов в C++.

Будьте описательны и избегайте слишком коротких имен (например, numberOfStudents лучше, чем n).
Избегайте использования однобуквенных имен переменных, за исключением простых счетчиков (например, i, j, k).

Вот несколько примеров хороших и плохих имен переменных:

// Хорошо
int age = 30;
double totalPrice = 150.99;      // camelCase
int numberOfStudents = 25;       // camelCase
const int MAX_STUDENTS = 100;    // SCREAMING_SNAKE_CASE для констант

// Плохо
int a = 30;  // Слишком коротко и непонятно
double TOTAL_PRICE = 150.99;  // Верхний регистр не предназначен для обычных переменных
int n = 25;  // Слишком коротко и непонятно

Шпаргалка

Правила именования в C++:

Имена могут содержать буквы, цифры и символы подчеркивания
Имена должны начинаться с буквы или символа подчеркивания
Имена чувствительны к регистру (myVar ≠ myvar)
Имена не могут быть ключевыми словами C++ (например, int, float)

Общие соглашения об именовании:

camelCase — переменные и функции: totalAmount
PascalCase — имена классов: MyClass
snake_case — имена файлов / другие языки: total_amount
SCREAMING_SNAKE_CASE — константы и макросы: MAX_SIZE
Будьте описательны; избегайте коротких или неясных имен (предпочитайте numberOfStudents вместо n)
Однобуквенные имена допустимы только для простых счетчиков (i, j, k)

int age = 30;                    // хорошо
double totalPrice = 150.99;      // camelCase
const int MAX_STUDENTS = 100;    // SCREAMING_SNAKE_CASE

int a = 30;                      // плохо: неясно
double TOTAL_PRICE = 150.99;     // плохо: верхний регистр для неконстанты

Попробуйте сами

В этом уроке нет задания по программированию.