Перейти к основному содержимому

Именование

Имя связывает смысл задачи и ячейку памяти

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

Коротко

Имена пишем английскими буквами. В первых уроках выбираем короткие слова: speed, dist, time, sum, count, mode. Если нужно два слова, используем нижнее подчёркивание: max_speed.

Что можно использовать в имени

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

МожноНельзяПочему
speed2speedимя не может начинаться с цифры
distrobot-speedминус читается как операция
max_speedclassclass — слово языка C++
count1скоростьв разделе не используем русские буквы в коде

C++ различает регистр: speed, Speed и SPEED — разные имена.

Учебный стандарт раздела

В этом разделе используем такие правила:

  1. имена на английском;
  2. переменные — маленькими буквами;
  3. сначала одно короткое слово;
  4. если без двух слов неясно, пишем max_speed;
  5. не используем русские буквы в коде;
  6. не называем разные вещи почти одинаково.

Пример:

#include <iostream>
using namespace std;

int main() {
int speed = 60;
int dist = 30;
int time = 5;

cout << speed << endl;
cout << dist << endl;
cout << time << endl;
return 0;
}

Популярные стили

СтильПримерГде встречается
одно словоspeedпростые учебные программы
snake_casemax_speedC, Python, часть C++ проектов
camelCasemaxSpeedJavaScript, Java, часть C++ проектов
PascalCaseMotorDriverимена классов в некоторых проектах
UPPER_CASEMAX_SPEEDконстанты и макросы в старом коде

На первых занятиях не смешивайте стили без причины. Если начали писать max_speed, не пишите рядом maxSpeed для такой же идеи.

Один смысл можно записать разными стилями

Плохие и хорошие имена

ПлохоЛучшеПочему
xspeedпонятно, что хранится
thingdistменьше пустого смысла
distanceFromFrontSensorInCentimetersdistдля первого знакомства слишком длинно
d1, d2, d3left, mid, rightвидна роль значения

Имена a, b, c допустимы в коротком математическом примере. В программе робота лучше использовать короткое слово по смыслу.

Практика

  1. Придумайте имена для скорости, расстояния, времени и режима.
  2. Исправьте имена x1, x2, thing в маленькой программе.
  3. Запишите три имени в стиле snake_case.
  4. Найдите в своём коде имя длиннее 12 символов и сократите его без потери смысла.
  5. Объясните, почему class нельзя использовать как имя переменной.

Проверьте себя

  1. Почему в учебном коде используем английские имена?
  2. Можно ли начать имя с цифры?
  3. Чем speed отличается от Speed?
  4. Когда допустимы имена a, b, c?
  5. Какой стиль принят в этом разделе?
Ориентиры для самопроверки

Сначала ответьте без подсказки. Ответ можно считать полным, если вы:

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

Если один из пунктов объяснить не получается, найдите соответствующую главу статьи, перечитайте её и повторите ответ.

Словарь статьи

ТерминЗначение
идентификаторимя переменной, функции или другого элемента кода
стиль именованиядоговорённость о записи имён
snake_caseстиль с нижним подчёркиванием
camelCaseстиль, где второе слово начинается с большой буквы
ключевое словослово, занятое языком C++

Связанные темы

Источники