Як називати функцію
Вдалий вибір назв функцій є неодмінною частиною написання якісного коду.
Розгляньмо наведені нижче рекомендації, коли даємо назву своїй функції.
Обираймо змістовні назви функцій
Даючи назву функції, варто чітко розуміти, що вона робить.
Наприклад, назва функції get(studentId, subject) нічого не говорить про її призначення, тому незрозуміло, що вона робить.
Можливо, вона повертає оцінку студента з предмета, а можливо, його статус зарахування.
Кращою назвою буде getStudentGrade(studentId, subject), бо вона точно передає, що саме робить функція.
Не робимо назву функції занадто довгою
Стежмо за тим, щоб назва функції не була занадто довгою.
Наприклад, назва функції checkStudentFailOrPassOrMeritOrDistinction(mark) зайво довга.
Чим довша назва, тим важче її запамʼятати і тим більше місця вона займає на екрані.
Не робимо назву функції занадто короткою
І навпаки, занадто коротка назва функції теж може заплутати читачів.
Наприклад, checkFPMD(mark) - погана назва функції, бо не відразу зрозуміло, що означає «FPMD».
Використовуймо назву, зрозумілу всім
Назва функції має бути зрозумілою кожному, хто читає наш код.
Наприклад, незрозуміла назва функції на кшталт DeathStar() може здатися нам кумедною, але вона не передає її призначення і може заплутати інших розробників, які читають наш код.
Обираймо єдину конвенцію для назв операцій
Дотримуймося однієї конвенції для назв операцій, які роблять те саме.
Наприклад, якщо функцію для отримання імені студента ми назвали getStudentName(), то для отримання оцінки студента не варто використовувати в назві інше дієслово (наприклад, retrieveStudentGrade()).
Не використовуймо те саме слово для двох різних цілей
Наприклад, не варто щоразу використовувати add, коли ми хочемо покласти групу елементів у колекцію, якщо ми вже використали це слово для додавання двох чисел.
Натомість використовуймо insert або append.
