Читаемость именования логических методов

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

public boolean isUserExist(...)

или:

public boolean doesUserExist(...)

или:

public boolean userExists(...)

public boolean userExists(...)

Было бы моим предпочтением. Поскольку это делает ваши условные проверки более похожими на естественный английский:

if userExists ...

Но я думаю, что нет жесткого правила - просто будьте последовательны

Я бы сказал userExists, потому что в 90% случаев мой вызывающий код будет выглядеть так:

if userExists(...) {
  ...
}

и это очень буквально читается по-английски.

if isUserExistи if doesUserExistкажутся излишними.

Остерегайтесь жертвовать ясностью в погоне за удобочитаемостью .

Хотя if (user.ExistsInDatabase(db))читается лучше, чем if (user.CheckExistsInDatabase(db)), рассмотрим случай класса с шаблоном построителя (или любого класса, для которого вы можете установить состояние):

user.WithName("Mike").ExistsInDatabase(db).ExistsInDatabase(db2).Build();

Неясно, ExistsInDatabaseпроверяет ли он, существует ли он, или устанавливает факт его существования. Вы не стали бы писать if (user.Age())или if (user.Name())без какого-либо значения сравнения, так почему if (user.Exists())это хорошая идея, потому что это свойство / функция имеет логический тип, и вы можете переименовать функцию / свойство, чтобы читать больше как естественный английский? Неужели так плохо следовать тому же шаблону, который мы используем для других типов, кроме логических?

С другими типами ifоператор сравнивает возвращаемое значение функции со значением в коде, поэтому код выглядит примерно так:

if (user.GetAge() >= 18) ...

Это звучит так: «если возраст пользователя больше или равен 18 ...», правда - это не «естественный английский», но я бы сказал, что object.verbникогда не напоминал естественный английский, и это просто базовый аспект современного программирования (для многие основные языки). У программистов обычно нет проблем с пониманием приведенного выше утверждения, разве следующее хуже?

if (user.CheckExists() == true)

Что обычно сокращается до

if (user.CheckExists())

Затем последовал роковой шаг

if (user.Exists())

Хотя было сказано, что «код читается в 10 раз чаще, чем пишется», также очень важно, чтобы ошибки были легко обнаружены. Предположим, у вас есть функция Exists (), которая вызывает существование объекта и возвращает истину / ложь в зависимости от успеха. Вы могли легко увидеть код if (user.Exists())и не заметить ошибку - ошибка была бы намного более очевидной, если бы код читался, if (user.SetExists())например.

Кроме того, user.Exists () может легко содержать сложный или неэффективный код, обращаясь к базе данных, чтобы что-то проверить. user.CheckExists () дает понять, что функция что-то делает.

См. Также все ответы здесь: Соглашения об именах: как назвать метод, возвращающий логическое значение?

В качестве заключительного примечания - после «Скажи, не спрашивай» многие функции, возвращающие истину / ложь, все равно исчезают, и вместо того, чтобы запрашивать у объекта его состояние, вы говорите ему сделать что-то, что он может делать в разных способы в зависимости от его состояния.

Целью обеспечения удобочитаемости всегда должно быть написание кода, максимально приближенного к естественному языку. Так что в данном случае это userExistsкажется лучшим выбором. Тем не менее, использование префикса «is» может быть правильным, например, в других ситуациях isProcessingComplete.

Я бы выбрал userExists (), потому что 1) это имеет смысл на естественном языке и 2) он следует соглашениям API, которые я видел.

Чтобы понять, имеет ли это смысл на естественном языке, прочтите его вслух. «Если пользователь существует» больше похоже на допустимую английскую фразу, чем «если пользователь существует» или «если пользователь существует». «Если пользователь существует» было бы лучше, но «the», вероятно, излишне в имени метода.

Чтобы узнать, существует ли файл в Java SE 6, вы должны использовать File.exists () . Похоже, что в версии 7 будет так же . C # использует то же соглашение , что и Python и Ruby . Надеюсь, это достаточно разнообразный сборник, чтобы назвать это языково-независимым ответом. В общем, я бы предпочел методы именования в соответствии с API вашего языка.

Есть вещи, которые следует учитывать, которые, как мне кажется, были упущены в нескольких других ответах здесь

1. Это зависит от того, является ли это методом класса C ++ или функцией C. Если это метод, то он, скорее всего, будет вызван if (user.exists()) { ... }или if (user.isExisting()) { ... }
   нет if (user_exists(&user)). Это причина того, что стандарты кодирования гласят, что методы bool должны начинаться с глагола, поскольку они будут читаться как предложение, когда объект находится перед ними.

2. К сожалению, многие старые функции C возвращают 0 в случае успеха и ненулевое значение в случае неудачи, поэтому может быть сложно определить используемый стиль, если вы не следуете, чтобы все функции bool начинались с глаголов или всегда сравнивались с true, например if (true == user_exists(&user))

Мое простое правило на этот вопрос таково:

Если в логическом методе уже ЕСТЬ глагол, не добавляйте его. В противном случае подумайте об этом. Некоторые примеры:

$user->exists()
$user->loggedIn()
$user->isGuest() // "is" added

Чисто субъективно.

Я предпочитаю, userExists(...)потому что тогда такие утверждения читаются лучше:

if ( userExists( ... ) )

или

while ( userExists( ... ) )

В данном конкретном случае первый пример - такой ужасный английский, что я вздрагиваю.

Я бы, вероятно, выбрал номер три из-за того, как он звучит при чтении операторов if. «Если пользователь существует» звучит лучше, чем «Если пользователь существует».

Конечно, предполагается, что он будет использоваться в тестах оператора if ...

Мне нравится любой из них:

userExists(...)
isUserNameTaken(...)
User.exists(...)
User.lookup(...) != null

Имена методов служат для удобочитаемости, лучше всего подходят только те, которые вписываются во весь ваш код, в большинстве случаев они начинаются с условий, поэтому subjectPredicate следует естественной структуре предложения.

Почему бы тогда не переименовать собственность?

if (user.isPresent()) {