Вибір імен змінних, які слідують правилам і правилам
- 6 хвилин
Розробник програмного забезпечення одного разу відомий сказав: "Найважча частина розробки програмного забезпечення називає речі". Ім'я змінної не тільки має відповідати певним правилам синтаксису, його також слід використовувати, щоб зробити код більш зрозумілим і зрозумілим для читання людиною. Це багато, щоб запитати один рядок коду!
Правила змінних імен
Є деякі змінні правила іменування, які застосовуються компілятором C#.
- Імена змінних можуть містити буквено-цифрові символи та символ підкреслення (_). Спеціальні символи, наприклад фунт
#, тире-, і знак$долара заборонено. - Імена змінних мають починатися з букви або підкреслення, а не числа. Використання символу підкреслення для запуску імені змінної зазвичай зарезервовано для полів приватного екземпляра. Посилання на подальше читання можна знайти в зведенні модуля.
- Імена змінних не мають бути ключовим словом C#. Наприклад, такі оголошення імен змінних не можна використовувати:
float float;абоstring string;. - Імена змінних чутливі до регістра, що означає, що
string MyValue;вони єstring myValue;двома різними змінними.
Змінні іменні угоди
Конвенції – це пропозиції, які узгоджуються спільнотою розробників програмного забезпечення. Хоча ви можете вирішити не дотримуватися цих конвенцій, вони настільки популярні, що іншим розробникам може бути важко зрозуміти ваш код. Ви повинні практикувати прийняття цих конвенцій і зробити їх частиною ваших власних звичок кодування.
- У назвах змінних слід використовувати верблюжий регістр, який є стилем письма, який використовує малу літеру на початку першого слова та велику літеру на початку кожного наступного слова. Наприклад:
string thisIsCamelCase;. - Імена змінних мають бути описові та змістовні у вашій програмі. Слід вибрати ім'я змінної, яка позначає тип даних, які вона зберігатиме (а не тип даних). Наприклад,
bool orderComplete;, NOTbool isComplete;. - Імена змінних мають бути одним або кількома цілими словами, доданими разом. Не використовуйте скорочення, оскільки ім'я змінної може бути незрозумілим для інших користувачів, які читають ваш код. Наприклад,
decimal orderAmount;, NOTdecimal odrAmt;. - Імена змінних не повинні містити тип даних змінної. Ви можете побачити кілька порад, щоб використовувати стиль, як
string strMyValue;. Це був популярний стиль багато років тому. Однак більшість розробників більше не дотримуються цієї поради, і є вагомі причини, щоб не використовувати її.
У цьому прикладі string firstName; наведено всі ці правила та правила, за умови, що цю змінну потрібно використовувати для зберігання даних, які представляють ім'я користувача.
Приклади змінних імен
Ось кілька прикладів змінних оголошень (з використанням поширених типів даних):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Інші правила іменування
Правила та домовленості, описані вище, призначені для локальних змінних. Локальна змінна – це змінна, яка має область видимості в тілі методу, або змінна в консольному додатку, яка використовує інструкції верхнього рівня (як код у цьому модулі).
Існують інші типи конструкцій, які можна використовувати в програмах, і багато хто має свої власні угоди. Наприклад, класи часто використовуються в програмах C# і мають пов'язані з ними конвенції. Хоча ви не створюватимете класи в цьому модулі, важливо знати, що правила іменування, про які ви щойно дізналися, вписуються в більшу структуру іменування.