Мені подобається використовувати знак питання в кінці назв методів / функцій іншими мовами. Java не дозволяє мені цього робити. Як обхідний шлях, як інакше я можу назвати логічні методи повернення в Java? Спользование is, has, should, canв передній частині методи звуку добре для деяких випадків. Чи є кращий спосіб назвати такі методи?
Наприклад, наприклад, createFreshSnapshot?
pкінець імені методу
Відповіді:
Конвенція полягає в тому, щоб задати питання від імені.
Ось кілька прикладів, які можна знайти в JDK:
isEmpty()
hasChildren()Таким чином, імена читаються так, ніби вони мають знак запитання в кінці.
Колекція порожня?
Чи є у цього Вузла діти?
І, тоді, trueозначає так, і falseозначає ні.
Або ви можете прочитати це як твердження:
Колекція порожня.
Вузол має дітей
Примітка:
Іноді вам може знадобитися назвати метод приблизно таким createFreshSnapshot?. Без знака питання назва означає, що метод повинен створювати знімок, а не перевіряти, чи потрібен такий.
У цьому випадку вам слід переосмислити те, про що ви насправді просите. Щось на зразок isSnapshotExpiredнабагато кращої назви і передає те, що метод скаже вам, коли його буде викликано. Дотримання подібного шаблону також може допомогти зберегти більшу частину своїх функцій чистими та без побічних ефектів.
Якщо ви робите пошук Google для isEmpty()в API Java, ви отримаєте багато результатів.
isSnapshotExpiredабо щось подібне. (за вашими критеріями)
shouldHeartbeat()методу.
isEmpty()і hasChildren()є питаннями , а не твердженнями ? Насправді це читається трохи краще англійською мовою, якщо ви вважаєте ці імена твердженнями чи предикатами.
Якщо ви хочете, щоб ваш клас був сумісним із специфікацією Java Beans , щоб інструменти, що використовують відображення (наприклад, JavaBuilders , JGoodies Binding ), могли розпізнавати логічні геттери, як використання, так getXXXX()і isXXXX()як назву методу. З специфікації Java Beans:
8.3.2 Логічні властивості
Крім того, для логічних властивостей ми дозволяємо методу геттера відповідати шаблону:
public boolean is< PropertyName >();Цей метод "є < ім'я_назви >" може бути наданий замість методу "отримати < ім'я_назви >" або може бути наданий на додаток до методу "отримати < ім'я_назви >". У будь-якому випадку, якщо для логічного властивості присутній метод “є < Ім'я_назви >”, тоді ми будемо використовувати метод “є < Ім'я_назви >” для зчитування значення властивості. Прикладом логічного властивості може бути:
public boolean isMarsupial(); public void setMarsupial(boolean m);
public boolean is<PropertyName>(); це схоже на загальне.
Я хочу опублікувати це посилання, оскільки це може додатково допомогти тим, хто перевіряє цю відповідь і шукає більше стилів Java
Вказівки щодо стилю програмування на Java
Пункт "2.13 - префікс, слід використовувати для булевих змінних та методів." є особливо актуальним і пропонує префікс is .
Далі керівництво стилем пропонує:
Є кілька альтернатив префіксу is, який краще підходить у деяких ситуаціях. Це префікси has , can і should :
boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;Якщо ви дотримуєтесь Рекомендацій, я вважаю, що буде названий відповідний метод:
shouldCreateFreshSnapshot()Для методів, які можуть не вдатися, тобто ви вказали логічне значення як тип повернення, я б використовував префікс try:
if (tryCreateFreshSnapshot())
{
// ...
}Для всіх інших випадків використовуйте префікси типу is.. has.. was.. can.. allows....
Я хочу вказати на інший погляд на цю загальну конвенцію іменування, наприклад:
див. java.util.Set :boolean add(E e)
де обґрунтування:
виконайте деяку обробку, а потім повідомте, вдалося це чи ні .
Хоча returnдійсно booleanім'я методу має вказувати на завершення обробки замість типу результату (логічне значення для цього прикладу).
createFreshSnapshotМені ваш приклад здається більше пов’язаним з цією точкою зору, оскільки, здається, означає це: створити свіжий знімок, а потім повідомити, чи вдалася операція створення. Враховуючи ці міркування, назва createFreshSnapshotвидається найкращою для вашої ситуації.
?в назві методу?