Выберите имена переменных, которые соответствуют правилам и соглашениям

6 мин

Один программист однажды сказал: "Самая сложная часть разработки программного обеспечения - это дать правильные имена вещам." Имя переменной должно не только соответствовать определённым правилам синтаксиса, но и способствовать тому, чтобы код был более доступным и понятным для человека. Это слишком много для одной строки кода!

Правила имен переменных

Существуют некоторые правила именования переменных, которые применяются компилятором C#.

Имена переменных могут содержать буквенно-цифровые символы и символ подчеркивания (_). Специальные символы, такие как фунт #, тире -, и знак $ доллара не допускаются.
Имена переменных должны начинаться с алфавитной буквы или подчеркивания, а не с цифры. Использование символа подчеркивания в начале имени переменной обычно зарезервировано для приватных полей экземпляра. Ссылку на дальнейшее чтение можно найти в сводке модуля.
Имена переменных не должны быть ключевым словом C#. Например, эти объявления названий переменных не будут разрешены: float float; или string string;.
Имена переменных чувствительны к регистру, что означает, что string MyValue; и string myValue; являются двумя разными переменными.

Соглашения об именовании переменных

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

Имена переменных должны использовать верблюжий стиль, который предполагает строчную букву в начале первого слова и заглавную букву в начале каждого последующего слова. Например: string thisIsCamelCase;.
Имена переменных должны быть описательными и значимыми в приложении. Вы должны выбрать имя переменной, представляющей тип данных, которые будут храниться (а не тип данных). Например, bool orderComplete;, НЕ bool isComplete;.
Имена переменных должны быть одним или несколькими словами, добавленными вместе. Не используйте сокращения, так как имя переменной может быть неясно для других, кто читает ваш код. Например, decimal orderAmount;, НЕ decimal odrAmt;.
Имена переменных не должны включать тип данных переменной. Вы можете увидеть некоторые советы по использованию стиля, например string strMyValue;. Это был популярный стиль лет назад. Однако большинство разработчиков больше не следуют этим советам, и есть хорошие причины не использовать его.

Этот пример string firstName; следует всем этим правилам и соглашениям, предполагая, что вы хотите использовать эту переменную для хранения данных, представляющих имя пользователя.

Примеры имени переменной

Ниже приведены несколько примеров объявлений переменных (с использованием распространенных типов данных):

char userOption;

int gameScore;

float particlesPerMillion;

bool processedCustomer;

Другие правила именования

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

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

Обратная связь

Были ли сведения на этой странице полезными?

Выберите имена переменных, которые соответствуют правилам и соглашениям

Проверьте свои знания

Обратная связь