Veri almak için yöntem adları [kapalı]

Uyarı: Bu, yayınladığım çok ciddi bir soru / tartışma değil ... ancak çoğu geliştiricinin bu "sorunu" düşündüğüne bahse girmeye hazırım ...

Her zaman bir yerden veri alan ve geri döndüren yöntemler için adlandırma kuralları ile ilgili başka görüşler almak istedim ...

Çoğu yöntem adı biraz basit ve açıktır ... SaveEmployee (), DeleteOrder (), UploadDocument (). Tabii ki sınıflarda büyük olasılıkla kısa biçimi kullanırsınız ... Sırasıyla Kaydet (), Sil (), Yükle ().

Ancak, her zaman ilk eylemle uğraştım ... verileri nasıl elde edeceğim. Görünüşe göre her proje için farklı adlandırma kuralları arasında gidip geliyorum çünkü son kullandığımdan asla pek memnun değilim. Söyleyebileceğim kadarıyla olasılıklar bunlar ->

• GetBooks ()
• FetchBooks ()
• RetrieveBooks ()
• FindBooks ()
• LoadBooks ()

Senin düşüncen ne

Her şey tutarlı anlambilimle ilgili ;

Soru başlığınızda veri almayı kullanırsınız . Bu, anlamsal olarak önemli ölçüde belirsiz olmayan bir şekilde almanın ne anlama geldiğini tanımlamanız gereken bir anlamda son derece geneldir . Bir şeyleri adlandırmayı düşünürken sizi doğru yola sokmak için aşağıdaki örnekleri sunuyorum.

1. getBooks() bir nesneyle ilişkili tüm kitapları aldığınızda, set için kriterlerin zaten tanımlanmış olduğu ve nereden geldiklerinin gizli bir ayrıntı olduğu anlamına gelir.
2. findBooks(criteria) yöntem çağrısının parametrelerine dayalı olarak kitapların bir alt kümesini bulmaya çalışırken, bu genellikle farklı arama kriterleriyle aşırı yüklenecektir.
3. loadBooks(source) dosya veya veri tabanı gibi harici bir kaynaktan yükleme yaptığınız zamandır.
4. Onlar çok belirsiz ve conflated olsun çünkü almak / getirme kullanmak olmaz olsun ve şartları ile ilgili herhangi bir kesin semantik yoktur.

Örnek: fetch , bazı varlıkların uzaktaki bir şeyi alıp geri getirmesi gerektiğini ifade eder. Köpekler bir sopa alıp, ve almak için eşanlamlıdır getir öncesinde de bir şey ilave anlamsal olmuş olabilir o bulundurmakla. get aynı zamanda elde etmenin eşanlamlısıdır, bu da bir şeye yalnızca sahip olduğunuzu ve başka hiç kimsenin aynı anda elde edemeyeceğini gösterir.

Anlambilim son derece önemlidir:

anlamla ilgili dilbilim ve mantık dalı

Comments gibi jenerik terimler kanıtlıyor olsun ve getirme semantik hiçbir özgü olması ve farklı kişiler tarafından farklı yorumlanır. Bir terim için bir semantik seçin, anlambilim net değilse ve kullanımıyla tutarlıysa neyi ifade etmesi amaçlandığını belgeleyin.

Belirsiz veya belirsiz anlamlara sahip kelimelere, kişisel görüşlerine dayanan önyargıları ve önyargıları nedeniyle farklı kişiler tarafından farklı anlamlar verilir ve bu asla iyi bitmez.

Dürüst olmak gerekirse, hangi adlandırma kuralını kullanacağınıza ekibinizle birlikte karar vermelisiniz. Ama eğlenmek için, bunlardan herhangi birine karar vermek için ne düşündüğünüzü görelim:

• GetBooks ()

Bu yöntem bir veri kaynağına aittir ve onları nasıl elde ettiği umurumuzda değil, sadece onları veri kaynağından almak istiyoruz.

• FetchBooks ()

Veri kaynağınıza bir tazı gibi davranıyorsunuz ve kitaplarınızı getirmek onun görevi. Sanırım ağzına kaç tane sığdırabileceğine kendi başına karar vermelisin.

• FindBooks ()

Veri kaynağınız bir kütüphanecidir ve kitaplarınızı bulmak için Dewey Decimal sistemini kullanacaktır.

• LoadBooks ()

Bu kitaplar bir tür "elektronik kitap çantasına" aittir ve içine yüklenmeleri gerekir. Kaybetmelerini önlemek için yükledikten sonra ZipClosed () 'i çağırdığınızdan emin olun.

• RetrieveBooks ()

Hiçbir şeyim yok.

Cevap, rahat olduğunuz şeye bağlı kalmak ve tutarlı olmaktır.

Bir barnes and nobles web siteniz varsa ve GetBooks () kullanıyorsanız, Movie varlığı gibi başka bir öğeniz varsa GetMovies () kullanın. Yani siz ve ekibiniz neyi seviyor ve tutarlı olun.

OO'da (C ++ / Java) getSomething ve setSomething kullanma eğilimindeyim, çünkü her zaman olmasa da çoğu zaman ya sınıftan o veri nesnesini temsil eden ya da onu ayarlayan - alıcı / ayarlayıcı çifti özel bir öznitelik alıyorum. Bir artı olarak, Eclipse bunları sizin için üretir.

Yüklemeyi yalnızca dosyaları kastettiğimde kullanmaya meyilliyim - "belleğe yükle" gibi ve bu genellikle ilkellere, yapılara (C) veya nesnelere yüklemeyi ima eder. Web için gönder / al kullanıyorum.

Yukarıda belirtildiği gibi, tutarlılık her şeydir ve buna çapraz geliştiriciler dahildir.

"Verileri elde etmek" için ne demek istediğin net değil. Veritabanından mı? Bir dosya? Hafıza?

Yöntem adlandırma hakkındaki görüşüm, rolünün herhangi bir belirsizliği ortadan kaldırmak ve ideal olarak belgelere bakma ihtiyacını karşılamaktır. Daha uzun yöntem isimleri pahasına bile bunun yapılması gerektiğine inanıyorum. Araştırmalara göre, çoğu orta seviye + geliştirici deve durumunda birden çok kelimeyi okuyabiliyor. IDE ve otomatik tamamlamalarla, uzun yöntem adları yazmak da sorun değildir.

Bu nedenle, bağlam çok net olmadığı sürece (örneğin, BookFetcherFromDatabase adlı bir sınıf) "fetchBooks" gördüğümde belirsizdir. Nereden getireceksin? Bul ve bul arasındaki fark nedir? Ayrıca, bazı geliştiricilerin anlambilimini belirli anahtar kelimelerle ilişkilendirmesi sorununu da riske atıyorsunuz. Örneğin, veritabanı için getirme (veya bellek) ile yükleme (dosyadan) veya indirme (web'den).

"FetchBooksFromDatabase", "loadBookFromFile", "findBooksInCollection", vb. Gibi bir şey görmeyi tercih ederim. Daha az göze çarpıyor, ancak uzunluğu bir kez aştığınızda, anlaşılır. Bunu okuyan herkes, yapmaya çalıştığınız şeyi hemen anlayacaktır.