Arabirim adlandırma: önek 'Can-' vs sonek '-Able'

'-Able' ifadesini arayüzler için sonek olarak kullanmak yaygındır;

Sıralanabilir Yazdırılabilir Numaralandırılabilir İçilebilir Atılabilir Döndürülebilir

'Can-''ın daha iyi olabileceğini düşünüyordum çünkü daha açıklayıcı olabilir. Evet, daha çok endişe verici ve arayüz adına ses ekliyor. Özellikle pasif fiiller kullanılabilir.

Örneğin 1 , Shootable, nesnenin ateş edebileceği anlamına gelir (bir silah bunu uygulayabilir) veya vurulabileceği anlamına gelir (bir hedef tahtası bunu uygulayabilir). 'Can-' öneki ile eski "CanShoot", ikincisi "CanBeShotAt" veya "CanShootAt" olur.

Örn. 2 'CanBePrinted' belgesi ve bir yazıcı 'CanPrint'

Ya da '-Able' ile yapışmalı ve belgelerin içeriği sağlamasına izin vermeli miyiz ?

Herhangi bir görüş

Belki de mümkün-mümkün mü?

.Net'ten bazı örnekler:

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

Tek tip bir standart görünmüyor. İyi okuyanlarla devam et.

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

EDIT: Belirttiğimiz gibi, soru Özellikler ile değil Arayüzlerle ilgilidir.

Bu durumda, Can- isimli bir arayüz bulamıyorum. Arayüzler her zaman kullanılabilme eğilimindedir. Bu terminolojiye katılırdım. Bir yöntem, a ISerializable objectveya parametresi olarak isteyebilir IPrintable document. Bir ICanBeSerialized objectveya a istemek ICanBePrinted documentokumak çok zordur.

Diğer tarafta, Yazıcı, sadece arayüzü çağırmanızı öneririm IPrinter. Yöntemin bir soruyor olacak IPrinter device.

Aşağıdaki yöntem imzasını sesli olarak okuyun. (Şahsen, ben "Ben" önekinin sessiz olduğunu düşünüyorum.) İyi okuyor mu? Sesi doğru mu?

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

Dilbilgisi ile konuşursak, "canFoobar" bir işarettir, oysa "Foobarable" bir sıfat ya da bir isimdir (genellikle bir API bağlamında bir isimdir).

Ayrıca dikkat çeken farklılığa dikkat edin: -able, uygulandığı isime pasif bir rol ima eder, yani eğer bir Şey foobarable ise, o zaman başka bir şey tarafından foobarred edilebilir; Aktif bir rol oynayabilir, yani, eğer bir şeyFoobar yapabilirse, o zaman başka bir şey için foobar yapabilir. Ya da, farklı bir açıdan: Bir B, daha sonra filanca eğer A.canFoobar()ve B is Foobarable.

OOP etkililiği açısından, isimler sınıflar veya arayüzler iken, öngörüleri yöntemlerle veya özelliklerle ilişkilendiririm. Yani:

instance.canFoobar();

class Something implements Foobarable { ... }

Şahsen ben -able sürümü ile sopa. İşte benim sebebim: Çoğu (tümü?) Grafik editörleri, yazdıklarınızı temel alarak tanımlayıcıları önerir. Bazıları tanımlayıcılar içinde arama yapmak için yeterince 'akıllı' olmasına rağmen, bazıları hala sadece tanımlayıcıların arama başlangıçlarını sunar.

Yazmayı hızlandırmak için, önerilen tanımlayıcıların listesini mümkün olduğu kadar az tuşa basarak kısaltmak istersiniz. Daha fazla tanımlayıcı aynı başlangıca sahiptir, örneğin 'ICan', daha fazla karakter yazmanız gerekir.

Bunun sizin durumunuzda bir sorun olmadığını düşünüyorsanız o zaman bu harika ve bir adlandırma kuralı seçmek için başka kriterler kullanmanızı tavsiye ederim. Bazı durumlarda, örneğin ekibimizde, mümkün olduğu kadar az tuşa basmadan sonra ayırt eden tanımlayıcıları tercih ediyoruz.

Bunun dışında, kodunuzu projede çalışanlar için daha anlaşılır kılan adlandırma kurallarını kullanmanızı tavsiye ederim. Takımın içinde sohbet et. Böyle bir hak ya da yanlış yoktur. Sadece işe yarayan sözleşmeler ve daha az işe yarayan sözleşmeler.

Unutmayın ki iyi refactoring araçları şeyleri istediğiniz sıklıkta yeniden adlandırmanıza izin verir. Bu yüzden farklı yaklaşımlarla denemek kolaydır.

Açıkça, önek ve sonek, farklı eylem türleri veya bir eylemin farklı yönleri için neredeyse açık seçimlerdir .

Mevcut kullanım ve tercihler, birçok nedenden dolayı tutarsız olabilir.

Eylem yapılır tarafından nesne:
CanShoot -> Bu sürgünler (at) bir şey
canFly -> O uçar
canchange -> Bu değişikliği

Eylem yapılır üzerindeki objenin:
Okunabilir -> Sen bunu okuyabilir
Writable -> Sen bunun (kadar) yazabilirsiniz
Yazdırılabilir -> Sen yazdırabilirsiniz

Bir kural olmasa ve hatta mantıklı bir şekilde mantıklı olsa da, sözleşmeyi benimsemeye ve değişken adlandırmada kullanım tutarlılığını sürdürmeye yardımcı olur.

Yetenek ve izin arasında ayrım yapmak isteyebileceğinizi düşünüyorum. Bir şeyin serileştirilebildiği anlamına gelir Serializableve CanSerializeima ederken , ayrıca izin sorunları da olabilir (veya belki de disk alanı eksikliği) ve göz önünde bulundurmanız gerekebilir MaySerialize. Bir şeyleri bırakmak, ve ~ablearasında ayrım yapma ihtiyacını ortadan kaldırır .canmay

Arabirimleri alt sınıflarken / uygularken, kuralın "B'nin A olduğunu" (B'nin A'yı uyguladığı) söyleyebilmeniz gerektiğini düşünüyorum. Söylemek doğru gelmiyor:

Bir Documenta,CanBePrinted

Ancak şunu söylemek doğru (veya en azından daha iyi) geliyor:

Bir Documenta,Printable

Hem gramer hem de geleneksel Xable'ın arayüz isimleri için daha iyi olduğunu düşünüyorum, IsX, CanX, DoesX ise özellik isimleri için daha iyi.

MSDN'den:

"Boolean özelliklerini olumlu bir cümle ile adlandırın (CantSeek yerine CanSeek). İsteğe bağlı olarak, Boolean özelliklerini ayrıca Is, Can veya Has ile de ekleyebilir, ancak değer katar." http://msdn.microsoft.com/en-us/library/ms229012.aspx

Bence "-able" varyantı, daha fazla deve humps uygulayan "CanDoSomething" önerdiğinizden çok daha okunaklı.

Scala'da *Ablearayüzler için kullanılır, ancak Can*tip sınıfı deseni için kullanılır. Temel olarak, belirli yöntemleri çağırabilmek için, belirli bir türde örtülü bir değerin kapsamı içinde bulunması gerekir. Bu türün adı bazen önceden eklenmiştir Can.