Назви інтерфейсу: префікс "Can-" vs суфікс "-Able"

Загальноприйнято використовувати "-able" як суфікс для інтерфейсів, наприклад

Serializable для друку Численні, які можна пити з можливістю зйомки

Я думав, що "Can-" може бути кращим, оскільки він може бути більш описовим. Так, він більш багатослівний і додає шуму назви інтерфейсу. Зокрема, можна використовувати пасивні дієслова.

Напр. 1 означає, що стрілянина означає, що об’єкт здатний стріляти (пістолет може реалізувати це), або це означає, що в нього можна стріляти (цільова дошка може це реалізувати). З префіксом "Can-" перший буде "CanShoot", а другий - "CanBeShotAt" або "CanShootAt".

Наприклад, документ "CanBePrinted" та принтер "CanPrint"

Або ми повинні дотримуватися "-Able" і нехай документація забезпечує контекст?

Будь-які думки.

Можливо, ви хочете Is-sposob?

Деякі приклади з .Net:

NetworkStream.Readable
NetworkStream.Writable
Stream.CanRead
Stream.CanWrite
Type.IsSerializable

Здається, не існує єдиного стандарту. Ідіть із тим, що добре читається.

if (document.IsPrintable && printer.CanPrint) { printer.Print(document) }

EDIT: Як зазначалося, питання стосувалося інтерфейсів, а не властивостей.

У цьому випадку я не можу знайти жодного інтерфейсу з назвою Can-. Інтерфейси, як правило, завжди зручні для використання. Я погодився б з цією термінологією. Метод може запитувати як параметр a ISerializable objectабо IPrintable document. Просити те ICanBeSerialized objectчи інше ICanBePrinted documentдуже незручно читати.

З іншого боку, Принтер, я б запропонував просто зателефонувати в інтерфейс IPrinter. Ваш метод буде запитувати про IPrinter device.

Прочитайте підпис методу нижче вголос. (Особисто я вважаю префікс "Я" мовчазним.) Чи добре він читається? Це правильно звучить?

void PrintDocument(IPrinter device, IPrintable document)
{
    device.Print(document)
}

Граматично кажучи, "canFoobar" - це присудок, тоді як "Foobarable" - прикметник або іменник (як правило, іменник у контексті API).

Також відзначте тонку різницю: -able передбачає пасивну роль до іменника, до якого він застосовується, тобто, якщо щось є Foobarable, то його можна обдурити чимось іншим; може - має на увазі активну роль, тобто якщо щось може бути Фобаром, то воно може підробляти щось інше. Або з іншого кута: якщо A може foobar B, то A.canFoobar()і B is Foobarable.

З точки зору виразності OOP я б асоціював предикати з методами чи властивостями, тоді як іменники - це класи чи інтерфейси. Так:

instance.canFoobar();

class Something implements Foobarable { ... }

Особисто я б дотримувався версії -able. Ось моя причина: Більшість (усіх?) Графічних редакторів пропонують ідентифікатори на основі того, що ви ввели. Хоча деякі з них достатньо «розумні», щоб також здійснювати пошук за ідентифікаторами, деякі все ще пропонують початкові пошукові ідентифікатори.

Щоб пришвидшити введення тексту, ви хочете скоротити список запропонованих ідентифікаторів якомога менше натискань клавіш. Чим більше ідентифікаторів мають той самий початок, наприклад, "ICan-", тим більше символів вам доведеться набрати.

Якщо ви вважаєте, що це не проблема у вашому випадку, то це чудово, і я б рекомендував використовувати інші критерії, щоб вибрати умову іменування. У деяких випадках, наприклад, в нашій команді, ми віддаємо перевагу ідентифікаторам, які розрізняють якнайменше натискань клавіш.

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

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

Очевидно, що префікс і суфікс - це майже очевидний вибір для різних типів дій, точніше, різних напрямків дії.

Поточне використання та налаштування можуть бути суперечливими через багато причин.

Дія виконується по об'єкту:
CanShoot -> Вона стріляє (в) що - то
CanFly -> Він летить
CanChange -> Це змінює

Дія виконується на об’єкті:
Читаемая -> Ви можете прочитати З її
записом -> Ви можете написати (до) Друкувати
-> Ви можете роздрукувати

Хоча це може не бути правилом або навіть обов'язково логічним, воно допомагає прийняти умову і підтримувати послідовність використання в назвах змінних.

Я думаю, ви можете розрізняти можливості та дозвіл. Хоча Serializableі CanSerializeмається на увазі, що щось може бути серіалізовано, також існують проблеми з дозволом (або, можливо, бракує місця на диску), і вам може знадобитися врахувати MaySerialize. Якщо залишити речі на ~ableшляху усуває необхідність розрізняти canі may.

Під час підкласифікації та реалізації інтерфейсів, я думаю, що головне правило полягає в тому, що ви повинні мати можливість сказати "B - це A" (де B реалізує A). Не правильно сказати:

А Document- цеCanBePrinted

Але звучить правильно (або принаймні краще) сказати:

А Document- цеPrintable

Я думаю, що як граматичний, так і конвенційний Xable краще для імен інтерфейсів, тоді як IsX, CanX, DoesX кращі для імен властивостей.

Від MSDN:

"Назвіть булеві властивості позитивною фразою (CanSeek замість CantSeek). За бажанням, ви також можете префіксувати булеві властивості за допомогою Is, Can або Has, але лише там, де вона додає значення." http://msdn.microsoft.com/en-us/library/ms229012.aspx

На мою думку, варіант, що «підходить», набагато читає, ніж запропонований «CanDoSomething», який накладає набагато більше горбиків верблюдів.

У Scala *Ableвикористовується для інтерфейсів, але Can*використовується для типового шаблону класу. По суті, щоб мати можливість викликати певні методи, імпліцитне значення певного типу повинно існувати в області застосування. Ім'я цього типу іноді має префікс Can.