Принципи вибору імен змінних

Найважливішим принципом іменування змінних полягає в тому, що ім’я повинно повністю і точно описувати сутність, яка представляється змінною, і, відповідно, легко читатись і легко запам’ятовуватись. Приклад:

Невдале іменування:

x= x-xx;

xxx= fido + SalesTax( fido );

x = x + LateFee(x1, x ) + xxx;

x = x + Interest(x1, x );

Вдале іменування:

balance = balance - lastPayment;

monthlyTotal = newPurchases + SalesTax(newPurchases);

balance = balance + LateFee(customerID, balance) + monthlyTotal;

balance = balance + Interest(customerID, balance);

Очевидно, що найкращим ім’ям є те, яке в словах повністю описує сенс змінної. Наприклад, змінну, що представляє число місць на стадіоні, можна назвати numberOfSeatsInTheStadium. Особливостями такого іменування є: позитивна – ім’я не потрібно розшифровувати, воно саме за себе говорить; негативна – ім’я занадто довге, щоб бути ефективним при практичному використанні.

Таблиця 1. Ефективні та неефективні імена

Сутність змінної	Вдалі імена	Невдалі імена
Сума, на яку на даний момент виписано чеки	runningTotal, checkTotal	written, ct, checks, CHKTTL, x, xl, x2
Швидкість потягу	velocity, trainVelocity, velocitylnMph	velt, v, tv, x, xl,x2, train
Поточна дата	currentDate, todaysDate	cd, current, c, x, xl, x2, date
Число рядків на сторінці	linesPerPage	lpp, lines, l, x, xl, x2

Хороше мнемонічне ім’я описує зазвичай проблему, а не її вирішення. Наприклад, запис даних про співробітників можна назвати inputRecord або employeeData. Перше – комп’ютерний термін, що виражає ідею введення даних. Друге відноситься до предметної області, тому має перевагу.

Оптимальна довжина змінної лежить, мабуть, десь між довжинами змінних x та maximumNumberOfPointsInModernOlympics. Занадто короткі імена страждають від недостатнього вираження сенсу, в той час, як занадто довгі роблять складнішим набір програми і можуть зіпсувати візуальну структуру. Вважається, що оптимальною є довжина ім’я 10-16 символів. Але це не значить, що всі імена повинні бути такими – просто, якщо є більш короткі імена, потрібно приділити увагу тому, чи досить ясно вони описують сутність змінної.

Таблиця 2. Вдалі та невдалі імена з точки зору довжини

Занадто довгі імена	numberOfPeopleOnTheUsOlympicTeam numberOfSeatsInTheStadium maximumNumberOfPointsInModernOlympics
Занадто короткі імена	n, np, ntm n, ns, nsisd m‚mp, max, points
Те, що потрібно	numTeamMembers, teamMemberCount numSeatsInStadium, seatCount teamPointsMax, pointsRecord

Чи завжди короткі імена є невдалими? Ні, не завжди. Якщо змінній присвоюється коротке ім’я, наприклад, i, то сама довжина ім’я говорить про те, що змінна є другорядною і має обмежену область дії. Загалом, довгі імена краще присвоювати глобальним змінним, або таким, які рідко використовуються, а коротші – локальним змінним або змінним, що викликаються в циклах.

В багатьох програмах використовуються змінні, в яких зберігаються обчислені значення – суми, середні величини тощо. Доповнюючи ім’я специфікатором типу Total, Sum, Average, Max, Min, Record, String або Pointer, бажано ставити його в кінці. Такий підхід має декілька переваг. По-перше, найзначущіша частина ім’я стоїть на початку, перша читається і перша сприймається. По-друге, прийнявши дану конвенцію, можна уникнути плутанини, коли записуються семантично однакові імена синтаксично по-різному, наприклад, totalRevenue та revenueTotal. По-третє, імена типу revenueTotal, expenseTotal, revenueAverage, expenseAverage мають приємну для ока симетрію. Винятком з даного правила є позиція специфікатора Num. При розташуванні на початку ім’я специфікатор Num позначає загальне число, наприклад, numCustomers – загальне число замовників. Якщо ж він вказується в кінці ім’я, то позначає індекс: customerNum – номер поточного замовника. Іншою ознакою даної відмінності є буква s в кінці ідентифікатора numCustomers. Але навіть в цьому випадку специфікатор Num часто приводить до плутанини, тому краще замість нього застосовувати Count чи Total для позначення кількості та Index для позначення номера: customerCount, customerIndex.

Читайте також:

<== попередня сторінка	\|	наступна сторінка ==>
Одиничність мети кожної змінної	\|	Структурне програмування

Не знайшли потрібну інформацію? Скористайтесь пошуком google:

Генерація сторінки за: 0.004 сек.