Ayrılmış sözcüklerden kaçınmak için kasıtlı yazım hataları

Sık sık, daha iyi veya daha kötüsü için ayrılmış sözcükler haline gelen, genel kelimelerin kasıtlı yanlış hecelemelerini içeren bir kod görüyorum:

• klassya clazziçin sınıfta :Class clazz = ThisClass.class
• kountSQL'de sayım için :count(*) AS kount

Şahsen ben bu okunabilirliği azaltır buluyorum. Kendi uygulamamda daha iyi bir ismin kullanılamayacağı çok fazla dava bulamadım - itemClassya da recordTotal.

Class için JavaDocs'tan bir örnek bunu parametrelerde gösterir:

 public <U> Class<? extends U> asSubclass(Class<U> clazz)

Bu makul bir kullanım durumu gösteriyor mu?

IMHO, bu çok kötü bir fikir. Ayrılmış kelimeler bir nedenle ayrılmıştır ve bunu yapmak okunabilirliği azaltır.

Ayrıca ikinci noktanıza tamamen katılıyorum. Bir değişken adlandırma class, bunu yapabileceğini bile bunu adlandırma kadar kötü olurdu tmpya a. Ne tür bir sınıf? Neyin sınıfı? İsimler açıklayıcı olmalıdır.

Python'un Stil Rehberi bu sorunu özel olarak ortaya koyuyor ve şunları söylüyor:

Genel özellik adınız ayrılmış bir anahtar kelimeyle çakışıyorsa, özellik adınıza tek bir izleyen alt çizgi ekleyin. Bu bir kısaltma veya bozuk yazım için tercih edilir.

Bu, belirli bir dilin anlambilimiyle çelişmediği varsayılarak oldukça iyi bir genel kural gibi görünüyor.

Kod kokusu.

string stringVariable = "";

Yukarıdaki kod, kullanım amacı olan değişkenler hakkında hiçbir şey söylemez.

class Klass

Aynı sorun

string UserNameString = "bmackey"

Yukarıdaki kod değişken adına eklenmiş anahtar kelime dizgisi gerektirmemelidir. Türleri değişken adına göre tanımlamaya ihtiyaç duyduğunuzda kodunuz çok uzun. Daralt'ı-refactor.

Şahsen, kod stiliniz için mükemmel bir seçenek olduğunu düşünüyorum.

Onlar ayrılmış kelimelerdir, bu nedenle derleyicinin dil-mekanik mi yoksa değişkeni mi istediğine karar vermesi gerekmez. Bunu akılda tutarak, insanların ayrılmış bir kelime gibi bir değişkene ihtiyaç duymalarını beklediklerini ima eder .

JDK 1.6 R21 ile gelen kaynağın içinden geçerken, 917 "clazz" oluşumunu buldum. Görünüşe göre kabul edilebilir bir tarz olduğunu düşünüyorlardı.

Ekibiniz bu konuda ne düşünüyor? Kötü olduğunu düşünüyorsanız, ancak ekibinizdeki diğer 9 kişi bunun iyi olduğunu düşünüyorsa, mermiyi ısırmanız ve kabul etmeniz gerekir. Neyin iyi neyin iyi olmadığı hakkında bir iletişim olduğu sürece ve onları gördüğünüz gibi gördüğünüz sorunları gündeme getirdiğiniz sürece, sorun değil.

Ekibinizin kod stili hakkında ne düşündüğü benim görüşümden veya bu yazıdaki başkasının görüşünden daha önemli . Bu ve sahip olabileceğiniz diğer kod tarzı kararları için de geçerlidir.

Ayrılmış sözcüklerden kaçınmak için kasıtlı yanlış yazımlar kötü bir fikirdir.

• Yazım hatalarını doğru yazımdan ayırt etmek zordur, bu nedenle kodu okumayı zorlaştırır.

• Yazım hatalarını hatırlamak zordur, bu nedenle bazı tutarsız yazım hatalarının kod içinde rekabet etmesi muhtemeldir; bu da kod yazmayı zorlaştırır ve okumayı zorlaştırır.

• Ayrılmış kelimeler, sorunu çözmek için kullanılan problemi değil, sorunu çözmek için kullanılan dili ifade eder. Bir değişken ismi, problemle ilgili bir kavramı işaret etmelidir.

Bu nedenle , ayrılmış kelimeyi aşağıdaki gibi nitelemek için alternatif, açıklayıcı bir isim seçmek veya tatmin edici bir alternatif yoksa, aşağıdakilerden daha iyidir :

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> benchmarkedClass = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(benchmarkedClass, benchmark.generatedMethod());
}

Class clazz"İyi bir isim bulmaya çalışmıyorum" gibi kokuyor. Bir değişken her zaman bir şeyi temsil eder ve iyi bir isim bunu açıklar. clazzÖrneğin, her koşulda mümkün olan en iyi isim olduğunu hayal etmeyi reddediyorum . Bir sınıfa başvuru mu -> class_reference, bir sınıf nesnesinin bir kopyasıdır -> class_copy, vs.

java.lang.SecurityManager.checkMemberAccess(Class<?> clazz, int which)
Parameters
    clazz -- the class that reflection is to be performed on.

Clazz, kontrolün gerçekleştirileceği hedef sınıftır.

checkMemberAccess(Class<?> target, int which)

parametrenin ne için kullanıldığını çok daha iyi tarif ederdi.

Bir değişken için ayrılmış bir ad kullanıyorlarsa, kötü adlandırılmış bir değişkendir. Sınıf yazılımı için Sınıf gibi meşru bir isim olsa bile.

Kötü adlandırılmış değişkenler, kötü düşünülmüş veya geçici kodun bir işaretidir - koruduğunuz Yazılım Parçası'ndaki diğer sonuçlara dikkat edin.

Kasten yanlış yazımların veya kısaltmaların, dikkatli ve tutarlı bir şekilde kullanılması halinde iyi bir fikir olduğunu düşünüyorum .

Java'da düşünün:

class X { public X() { } }
X x = new X();
x.getClass;  // Wha?  How does "get" help anything?
x.class;     // Best, but requires more lexer/parser work
x.klass;     // At least as good as getClass
x.clazz;     // Same

Yazım yanlışlarını kullanmanın yeri, ayrılmış sözcüğün iş için en iyi kelime olduğu yerdir. İki yer vardır değil sen için cazip olabilir yazım hatalarını kullanmak.

1. İyi bir isim düşünmek istemezsin
2. Sen sadece sahte bir değişken istiyorsun ve tanımlayıcı bir isme ihtiyacı yok

İlk durumda, tembelliğin nadiren kalite kodu oluşturmak için iyi bir politika olduğu açıktır. İkinci durumda, gerçekten kısa bir değişken seçin. Matematikçiler her zaman böyle yaparlar ve programcılar endeksler için yaparlar. Eğer gerçekten sadece bir kukla değişken ise, bunu endeksler için yapmanızla sınırlamak için hiçbir neden yoktur:

boolean isMyName(String testName) { return myName.equals(testName); }
boolean isMyName(String s) { return myName.equals(s); }

Date nextMeeting(Klass klass) { return /* something */ }
Date nextMeeting(Klass k) { return /* something */ }

Kodun metodu veya yapısı size ne olması gerektiğini söylerken kısa değişken isimlerinde hiçbir şey kaybetmezsiniz.

Class klassDüşüncelerinizi yaparken Classsınıfın bir örneği ile çalıştığınız meşru kullanımları gördüm .

Sık sık, daha iyi veya daha kötüsü için ayrılmış sözcükler haline gelen, genel kelimelerin kasıtlı yanlış hecelemelerini içeren bir kod görüyorum:

klass veya clazz sınıfı için: Class clazz = ThisClass.class

SQL'de sayım için kount: count (*) AS kount

Şahsen ben bu okunabilirliği azaltır buluyorum. Kendi uygulamamda, daha iyi bir ismin kullanılamadığı pek fazla vaka bulamadım - itemClass veya recordTotal.

Ancak, yardım edemem o kadar yaygın ki tek kişi ben miyim acaba? Herkes bu uygulama hakkında saygı duyulan programcıların önerilerini ve hatta daha iyi alıntılarını yaptı mı?

Yerel değişkenler ve biçimsel argümanlar için önemli değil.

Herhangi bir isim, kasıtlı olarak yanıltıcı veya rahatsız edici şekilde rahatsız edici olmadığı sürece iyidir. Örnekte:

public static Method findBenchmarkMethod(BenchmarkRecord benchmark) {
    Class<?> clazz = ClassUtils.loadClass(benchmark.generatedClass());
    return findBenchmarkMethod(clazz, benchmark.generatedMethod());
}

Tek bir yerel değişkenin "clazz" veya "klass" veya "cls" veya basitçe "c" olup olmadığı önemli değildir. Muhtemelen sadece ifadenin satır içi olur:

return findBenchmarkMethod(ClassUtils.loadClass(benchmark.generatedClass()),
                           benchmark.generatedMethod());

Bir değişken adının uzunluğu değişkenin kapsamı ile ilgili olmalıdır. Kısa metodlardaki yerel değişkenler için (ve hepsi kısa olmalıdır), çok kısa isimler iyi.

Yanlış yazımların her zaman kötü bir fikir olduğunu düşünüyorum. Sadece okuyucularınız için hoş değil. Birincisi, kelimeyi gördüğümde bir şeyleri özleyip özlemediğimi merak ediyorum klass. (Kast ettiler classmi, korsan mı demek istediler?) En azından benim için tanıdığım tüm yazım hataları rahatsız edici.

Rezerve edilen kelimenin gerçekten değişken hakkında bilinen tek önemli şey olduğu çok az durumda, aşağıdaki alternatifleri kullanırdım:

• Eğer bir işlev argümanı ise, aClassyerine kullanın class.

• Yerel veya üye bir değişkense, myClassyerine kullanın class.

• Bir erişimci ise, getClass()yerine kullanın class().

Tabii ki, eklenen önek oldukça anlamsız ve sonuç olarak yalnızca son çare olarak kullanılmalıdır. Ancak en azından okuyucunuzun zihinsel ayrıştırıcısına müdahale etmiyor ve ayrılmış sözcüklerden kaçınmanın güvenli bir yoludur.

Yaratıcı yazımın bir yararı, daha iyi arama yeteneğidir. Benzersiz kodlar için tam kod araması yapmanın, sık sık yanlış şeyleri bulacağınız ortak kelimelerden ve 1000 tanesinden daha kolay olduğunu düşünüyorum. Örnek olarak, ben kzpg.com'un sahibiydim. Google şimdi ve sadece birkaç isabet göreceksiniz. Bu benzersiz ve bu nedenle çok kolay.

Ancak bir ölçüye göre bu sorunun maddeden ziyade bir görüş olduğunu düşünüyorum. Ben şahsen Forth'da büyüdüm, her şey sözlerle ilgiliydi ve birçoğu. Biri parmaklarını kurtarmak için çok yaratıcı olmayı öğrendi. Sonunda kaynak tabanımda az çok 640.000 karakter vardı. Yani kelimeleri kısa tutmak, işin yapılması için önemliydi.