Какие рекомендации следует соблюдать при именовании переменных?

Question

Какие рекомендуемые рекомендации следует соблюдать при именовании переменных? Глобальные переменные?

Answer 1

Держите ваши имена значимыми, код должен самодокументироваться, избегайте сокращений, длина имени обычно не является проблемой в большинстве языков.

Булевы переменные должны начинаться is* или has*, попробуйте выбрать имя, которое не требует отрицания в тестах, поскольку ! часто можно пропустить.

Группируйте переменные, связанные с элементом, используя общий префикс, т.е. documentTitle, documentType, documentSize и т. Д.

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

Забудьте о венгерской нотации.

Answer 2

В значительной степени не имеет значения, какие стандарты вы решили принять.Наиболее важным фактором является то, что вы придерживаетесь этого!Согласованность действительно важна, и если вы решите, что ваш код будет значительно легче читать и поддерживать в будущем.

В качестве одной из идей вы можете проверить венгерскую нотацию, используемую для программирования на Win32 и C ++ под Windows.

Определение обозначения (PDF)

Answer 3

Некоторые широкие штрихи:

• Используйте i, j, k для переменных цикла.Это очень распространенная практика и ее легко понять.
• Для логических (true / false) переменных используйте имена предикатов, такие как isDirectory или canExecute.
• Независимо от того, camelCase или use_underscores это просто вопрос предпочтений.
• Может быть хорошей идеей будет украшать переменные венгерской нотацией, описывающей значение переменной, например, iMax может быть индексом максимумаэлемент в массиве.Менее полезно украшать имена информацией типа на уровне языка .Очень интересное объяснение разницы и почему одно хорошо, а другое плохо, см. эссе Джоэла .

Answer 4

Я ни в коем случае не опытный программист, но я в некоторой степени пробудил это в себе в колледже и университете и видел на таких сайтах, что при именовании переменных они должны означать что-то.

Может быть, это вещь для образования, но это имеет смысл - имя переменной должно легко понять, для чего эта переменная используется в любом месте вашего кода.Я думаю, это сводится к тому, что коду не нужно много комментариев - он должен объясняться сам.Именование переменных является частью этого.

Answer 5

Лучше не начинать их с цифр или символов на некоторых языках. Кроме того, не используйте зарезервированные функции языка, который вы используете. Например: в C # вы не хотите называть это «if», «else», «void», «try» и т. Д. *