Соглашения об именах для методов Java, возвращающих логическое значение (без знака вопроса)

Мне нравится использовать вопросительный знак в конце имен методов / функций на других языках. Java не позволяет мне этого делать. Как еще можно назвать логические методы возврата в Java в качестве обходного пути? Спользование is, has, should, canв передней части методы звука хорошо для некоторых случаев. Есть ли лучший способ назвать такие методы?

Например, createFreshSnapshot?

По соглашению вопрос задается от имени.

Вот несколько примеров, которые можно найти в JDK:

isEmpty()

hasChildren()

Таким образом, имена читаются так, как если бы в конце был вопросительный знак.

Коллекция пуста?
Есть ли у этого Узла дети?

А значит, trueзначит да и falseзначит нет.

Или вы могли бы прочитать это как утверждение:

Коллекция пуста.
У узла есть дети

Примечание.
Иногда вы можете захотеть назвать метод как-нибудь вроде createFreshSnapshot?. Без вопросительного знака название подразумевает, что метод должен создавать моментальный снимок, а не проверять, требуется ли он.

В этом случае вам следует переосмыслить то, о чем вы на самом деле спрашиваете. Что-то вроде isSnapshotExpired- это гораздо лучшее название, оно передает то, что вам скажет метод при его вызове. Подобный шаблон также может помочь сохранить больше ваших функций в чистоте и без побочных эффектов.

Если вы делаете поиск Google для isEmpty()в API Java, вы получите много результатов.

Если вы хотите, чтобы ваш класс был совместим со спецификацией Java Beans , чтобы инструменты, использующие отражение (например, JavaBuilders , JGoodies Binding ), могли распознавать логические геттеры, используя getXXXX()или isXXXX()как имя метода. Из спецификации Java Beans:

8.3.2 Логические свойства

Кроме того, для логических свойств мы разрешаем методу получения соответствовать шаблону:

public boolean is< Имя свойства > ();

Этот метод «is < PropertyName >» может быть предоставлен вместо метода «get < PropertyName >» или может быть предоставлен в дополнение к методу «get < PropertyName >». В любом случае, если для логического свойства присутствует метод «is < PropertyName >», мы будем использовать метод «is < PropertyName >» для чтения значения свойства. Примером логического свойства может быть:

public boolean isMarsupial();
public void setMarsupial(boolean m);

Я хочу опубликовать эту ссылку, так как она может помочь в дальнейшем для тех, кто проверяет этот ответ и ищет больше соглашений о стиле 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....

Стандартным является использование в качестве префикса «есть» или «имеет». Например isValid, hasChildren.

isэто тот, с которым я сталкивался чаще, чем любой другой. Однако все, что имеет смысл в текущей ситуации, - лучший вариант.

Я хочу по-другому взглянуть на это общее соглашение об именах, например:

см. java.util.Set :boolean add​(E e)

где обоснование:

сделайте некоторую обработку, затем сообщите , удалось ли это или нет .

Хотя returnэто действительно booleanимя метода должно указывать на завершение обработки, а не на тип результата (в данном примере логическое значение).

Ваш createFreshSnapshotпример кажется мне более связанным с этой точкой зрения, потому что, похоже, означает следующее: создайте свежий снимок, а затем сообщите, успешно ли завершилась операция создания. Учитывая эту аргументацию, название createFreshSnapshotкажется лучшим для вашей ситуации.