Kodlara bakarken hangi şeyler anında alarm zili çalar? [kapalı]

Birkaç hafta önce bir yazılım işçiliği etkinliğine katıldım ve yaptığım yorumlardan biri "Gördüğümüzde kötü kodları hepimiz tanıdığımızdan eminim" ve herkes daha fazla tartışma yapmadan başını salladı.

Bu tür şeyler her zaman beni endişelendiriyor, çünkü herkesin ortalamanın üstünde bir sürücü olduğunu sandığı gerçekçilik var. Kötü kodları tanıyabileceğimi düşünmeme rağmen, başkalarının kodlarının kokusu olarak gördükleri hakkında daha fazla şey öğrenmeyi çok isterim. Özellikle, bir kodda kod kokusu olan bir şeyden başka bir şey duymamanın ilginç olacağını düşünüyorum.

Kolay bir tane ile başlayacağım:

Kaynak denetiminde yüksek oranda yorumlanmış kod olan kod - neden orada? silinmek mi gerekiyordu? yarım iş bitti mi? belki de yorumlanmamalıydı ve sadece birisi bir şeyi test ederken mi yapılmıştı? Şahsen, buradaki tek garip hat olsa bile, gerçekten sinir bozucu olan bir şey buluyorum, ancak kodun geri kalanıyla serpiştirilmiş büyük bloklar gördüğünüzde bu tamamen kabul edilemez. Ayrıca, genellikle kodun geri kalanının da şüpheli kalitede olacağının bir göstergesidir.

/* Fuck this error */

Genellikle saçma bir try..catchblok içinde bulunur , dikkatimi çekmeye meyillidir. Sadece yaklaşık olarak /* Not sure what this does, but removing it breaks the build */.

Birkaç şey daha:

• Birden fazla iç içe geçmiş karmaşık ififade
• Düzenli olarak bir mantık akışını belirlemek için kullanılan try-catch blokları
• Jenerik isimlerle Fonksiyonlar process, data, change, rework,modify
• 100 çizgide altı veya yedi farklı bağlantı stili

Bulduğum bir tane:

/* Stupid database */
$conn = null;
while(!$conn) {
    $conn = mysql_connect("localhost", "root", "[pass removed]");
}
/* Finally! */
echo("Connected successfully.");

Doğru, çünkü kaba kuvvet vermek zorunda kalmak MySQL bağlantılarınızı doğru şeyler yapmaktır. Veritabanının bağlantı sayısıyla ilgili sorunları olduğu ortaya çıktı, bu yüzden zaman aşımına uğradılar. Bunu hata ayıklamak yerine, çalışana kadar tekrar tekrar denediler.

Benim için en büyük kırmızı bayrak yinelenen kod blokları çünkü kişinin ya programlama temellerini anlamadığını ya da var olan bir kod tabanında uygun değişiklikler yapmaktan çok korktuğunu gösteriyor.

Aynı zamanda kırmızı bayrak olarak yorum eksikliğini de sayıyordum, ancak kısa süre önce çok iyi bir kod üzerinde çalışmıştım.

Hiçbir gerçek değer katmamasına rağmen, programcının ne kadar akıllı olduğunu göstermeye çalışan kod:

x ^= y ^= x ^= y;

• 20.000 (abartı) hat fonksiyonları. Birkaç ekrandan fazlasını alan herhangi bir fonksiyonun yeniden faktoring yapılması gerekir.

• Aynı satırlar boyunca, sonsuza dek sürecek görünen sınıf dosyaları. Muhtemelen, orjinal sınıfın amacını ve işlevini ve hepsi de içsel yöntemler olmadıkça, muhtemelen kullanıldığı yerlerde, sınıfları soyutlayabilecek birkaç kavram vardır.

• açıklayıcı olmayan, önemsiz olmayan değişkenler veya çok fazla önemsiz açıklayıcı olmayan değişken. Bunlar aslında bir bilmece olanı çıkarıyor.

{ Let it Leak, people have good enough computers to cope these days }

Daha da kötüsü bu ticari bir kütüphaneden!

İngilizce bir derleyici olsaydı mükemmel bir şekilde derlenir ve çalışırdı, ancak kodun yapmadığı hiçbir şeyi tarif etmeyecek kadar ayrıntılı yorumlar.

//Copy the value of y to temp.
temp = y;
//Copy the value of x to y.
y = x;
//Copy the value of temp to x.
x = temp;

Ayrıca, yapılabilecek kodla ilgili yorumlar, bazı temel kurallara uyarlanmıştır:

//Set the age of the user to 13.
a = 13;

Derlendiğinde uyarı veren kod.

Açıklayıcı adlara sahip olmak yerine, adda sayılarla işlev görür , örneğin:

void doSomething()
{
}

void doSomething2()
{
}

Lütfen fonksiyon isimlerinin bir anlam ifade etmesini sağlayın! DoSomething ve doSomething2 benzer şeyler yaparsa, farklılıkları ayıran fonksiyon isimleri kullanın. DoSomething2, doSomething uygulamasından bir işlevsellik dağılımıysa, işlevsellik için adlandırın.

Sihirli Sayılar veya Sihirli Dizeler.

   if (accountBalance>200) { sendInvoice(...); }

   salesPrice *= 0.9;   //apply discount    

   if (invoiceStatus=="Overdue") { reportToCreditAgency(); }

• Belki de en kötüsü değil ama uygulayıcıların seviyesini açıkça gösteriyor:

  if(something == true) 

• Bir dilin for döngüsü veya yineleyici yapısı varsa, bir süre döngüsü kullanmak da uygulayıcılara dili anlama düzeyini gösterir:

  count = 0; 
  while(count < items.size()){
     do stuff
     count ++; 
  }
  
  for(i = 0; i < items.size(); i++){
    do stuff 
  }
  //Sure this is not terrible but use the language the way it was meant to be used.
  

• Dokümantasyonda / yorumlarda kötü yazım / dilbilgisi neredeyse kodun kendimde yer. Bunun nedeni, kodun insanların okuması ve makinelerin çalışması için olmasıydı. Bu nedenle, yüksek seviyeli dilleri kullanıyoruz, belgeleriniz zor olsa bile, beni önlem almadan kod bazının olumsuz bir görüşünü oluşturuyor.

Hemen farkettiğim derinden iç içe kod bloklarının sıklığıdır (eğer öyleyse, vb.). Kod sık sık iki ya da üç seviyeden fazla derinleşiyorsa, bu bir tasarım / mantık probleminin işaretidir. Ve eğer 8 yuva derinliğine inerse, ayrılmaması için lanet olası iyi bir neden olsa iyi olur.

Bir öğrencinin programını derecelendirirken, bazen "göz kırpma" tarzında bir an söyleyebilirim. Bunlar anlık ipuçları:

• Zayıf veya tutarsız biçimlendirme
• Bir satırda ikiden fazla boş satır
• Standart olmayan veya tutarsız adlandırma kuralları
• Tekrarlanan kod, tekrarlar ne kadar fazla olursa, uyarı o kadar güçlü olur
• Basit bir kod parçası ne olmalı, aşırı derecede karmaşıktır (örneğin, ana hatlara kıvrımlı bir şekilde kontrol edilen argümanları kontrol etme)

Nadiren ilk izlenimlerim yanlıştır ve bu uyarı zilleri zamanın yaklaşık % 95'inde doğrudur . Bir istisna için, dilde yeni bir öğrenci, farklı bir programlama diline ait bir stil kullanıyordu. Tarzını kazıp başka bir dilin deyimiyle tarzlarını tekrar okurken benim için alarm zilleri çıkardı ve öğrenci daha sonra tam kredi aldı. Ancak bu istisnalar nadirdir.

Daha gelişmiş kodlar dikkate alındığında, bunlar benim diğer uyarılarımdır:

• Veri tutmak için yalnızca "yapı" olan birçok Java sınıfının varlığı . Alanların kamuya açık veya özel olması ve alıcı / alıcı kullanması önemli değildir, hala iyi düşünülmüş bir tasarımın parçası değildir.
• Sadece isim alanı olmak gibi kötü isimleri olan ve kodda gerçek bir uyuşmazlık olmayan sınıflar
• Kodda kullanılmamış tasarım desenlerine referans
• Açıklama yapılmayan boş özel durum işleyicileri
• Kodu Eclipse’e getirdiğimde, çoğunlukla kullanılmayan ithalat veya değişkenler nedeniyle yüzlerce sarı “uyarı”

Stil açısından genelde görmek istemiyorum:

• Javadoc, yalnızca kodu ekleyen yorumlar

Bunlar sadece hatalı kodun ipucudur . Bazen kötü kod gibi gözüken şeyler aslında değildir, çünkü programcının niyetini bilmiyorsunuzdur. Örneğin, bir şeyin aşırı karmaşık görünmesi için iyi bir neden olabilir - oyunda başka bir konuyla ilgili olabilir.

Kişisel favori / evcil hayvan peeve: IDE, isimlendirilen isimler üretti. TextBox1 sisteminizde önemli ve önemli bir değişkense, kod incelemesi için gelecek başka bir şey daha var.

Tamamen kullanılmayan değişkenler , özellikle değişken kullanılan değişken adlarına benzer bir ada sahip olduğunda.

Birçok insan bahsetti:

//TODO: [something not implemented]

Bu şeylerin uygulanmasını diliyorum, en azından bir not aldılar. Daha kötüsü düşündüğüm şey:

//TODO: [something that is already implemented]

Todo'ları çıkarmak için hiç uğraşmazsanız değersiz ve kafa karıştırıcı!

Tümünü okumak için aşağı kaydırmamı gerektiren bir yöntem.

Metod isimlerinde bağlaçlar:

public void addEmployeeAndUpdatePayrate(...) 


public int getSalaryOrHourlyPay(int Employee) ....

Açıklama: Bunun alarm zillerinin çalmasının nedeni, tek bir sorumluluk ilkesini ihlal eden yöntemin muhtemel olduğunu göstermesi .

Açıkçası GPL'nin kaynak kodunu ticari, kapalı kaynaklı bir programa bağlamak.

Sadece acil bir yasal sorun oluşturmakla kalmaz, aynı zamanda deneyimlerime göre, kodda başka bir yere de yansıyan ya dikkatsizliği ya da kayıtsızlığı gösterir.

Dilde agnostik:

• TODO: not implemented
• int function(...) { return -1; } ("uygulanmadı" ile aynı)
• İstisnai olmayan bir nedenden dolayı bir istisna atma.
• Kötüye veya tutarsız kullanımı 0, -1veya nullistisnai dönüş değerleri.
• Asla başarısız olmamasını söyleyen ikna edici bir yorum içermeyen iddialar.

Dile özgü (C ++):

• Küçük harflerle C ++ Makroları.
• Statik veya Global C ++ değişkenleri.
• Başlatılmamış veya kullanılmamış değişkenler.
• Herhangi array newgörünüşte RAII-güvenli olmadığını.
• Dizinin veya işaretçinin, görünüşte sınırlanmayan herhangi bir kullanımı. Bu içerir printf.
• Bir dizinin başlatılmamış kısmının herhangi bir kullanımı.

Microsoft C ++ 'a özgü:

• Microsoft SDK başlık dosyalarından herhangi biri tarafından zaten tanımlanmış olan bir makroyla çakışan tanımlayıcı adları.
• Genel olarak, Win32 API'nin herhangi bir kullanımı büyük bir alarm zil kaynağıdır. Her zaman MSDN’yi açın ve şüpheniz olduğunda bağımsız değişkenleri / dönüş değeri tanımlarını arayın. (Edited)

C ++ / OOP’a özgü:

• Sanal sınıfın hem sanal hem de sanal olmayan yöntemlere sahip olduğu (sanal sınıf) sanal olanın ne olması gerektiği / neyin olmaması gerektiğine dair net bir ayrım olmadan uygulama (somut sınıf) mirası.

Tuhaf girinti stili.

Birkaç popüler stil var ve insanlar bu tartışmayı mezara götürecek. Ama bazen çok nadir, hatta evde yetişen bir girinti stili kullanan birini görüyorum. Bu, muhtemelen kendileri dışında kimseyle kodlanmadıklarının bir işaretidir.

Enums veya global olarak tanımlanmış değişkenler yerine çok sayıda metin bloğu kullanma.

İyi değil:

if (itemType == "Student") { ... }

Daha iyi:

private enum itemTypeEnum {
  Student,
  Teacher
}
if (itemType == itemTypeEnum.Student.ToString()) { ... }

En iyi:

private itemTypeEnum itemType;
...
if (itemType == itemTypeEnum.Student) { ... }

Zayıf yazılan parametreler veya yöntemlerde dönüş değerleri.

public DataTable GetEmployees() {...}

public DateTime getHireDate(DataTable EmployeeInfo) {...}

public void FireEmployee(Object EmployeeObjectOrEmployeeID) {...}

• Birden fazla üçlü operatör bir araya geldi, bu yüzden bir if...elsebloğa benzemek yerine bir bloğa if...else if...[...]...elsedönüştü
• Alt çizgi veya camelCasing içermeyen uzun değişken isimleri. Çektiğim bazı kodlardan örnekler:$lesseeloginaccountservice
• Bir dosyada yüzlerce kod satırı, çok az veya hiç yorum yok ve kod çok açık değil
• Aşırı karmaşık ififadeler. if (!($lessee_obj instanceof Lessee && $lessee_obj != NULL))Koddan örnek: aşağıya indirdiğimif ($lessee_obj == null)

Kod kokusu: en iyi uygulamaları izlememek

Bu tür şeyler her zaman beni endişelendiriyor, çünkü herkesin ortalamanın üstünde bir sürücü olduğunu sandığı gerçekçilik var.

İşte sizin için bir haber flaşı: Dünya nüfusunun% 50'si ortalama zekanın altında. Tamam, yani bazı insanlar tam olarak ortalama bir zekaya sahip olacaklar, ama seçici olamayalım. Ayrıca, aptallığın yan etkilerinden biri, kendi aptallığınızı tanıyamayacağınızdır! Bu ifadeleri birleştirirseniz işler pek iyi görünmez.

Kodlara bakarken hangi şeyler anında alarm zili çalar?

Pek çok güzel şeyden bahsedilmiştir ve genel olarak en iyi uygulamaları takip etmemek kod kokusu gibi görünmektedir .

En iyi uygulamalar genellikle rastgele icat edilmez ve genellikle bir sebepten dolayı vardır. Çoğu zaman öznel olabilir, ancak deneyimlerime göre çoğunlukla haklılar. En iyi uygulamaları takip etmek sorun olmamalı ve neden oldukları gibi olduklarını merak ediyorsanız, görmezden gelmekten ve / veya şikayet etmekten çok araştırın - belki de haklı, belki de değil.

En iyi uygulamanın bir örneği, yalnızca bir satır olsa bile, her if-block ile birlikte kıvrıklıklar kullanmak olabilir:

if (something) {
    // whatever
}

Gerekli olduğunu düşünmeyebilirsiniz, ancak son zamanlarda bunun büyük bir hata kaynağı olduğunu okudum . Her zaman parantez kullanmak Yığın Taşması üzerinde de tartışılmıştır ve ifadelerin parantez içinde olup olmadığının kontrolü, Java için statik bir kod analizörü olan PMD'de de bir kuraldır .

Unutmayın: "Çünkü bu en iyi uygulama", "neden bunu yapıyorsunuz?" Sorusuna asla kabul edilebilir bir cevap değildir. Bir şeyin neden en iyi uygulama olduğunu açıkça söyleyemiyorsanız, o zaman en iyi uygulama değildir, bu bir batıl inançtır.

“Bunun nedeni, froz alt sisteminin tasarımının tamamen etkilenmiş olmasıdır”.

Bu paragrafın tamamı boyunca devam ediyor.

Aşağıdaki refraktörün olması gerektiğini açıklarlar.

Ama yapmadı.

Şimdi, zaman veya yetkinlik sorunları nedeniyle o zaman patronları tarafından değiştirilemeyecekleri söylenebilirdi, ama belki de insanların küçük olması yüzünden.

Bir danışman bu j.randomu düşünüyorsa. programcı yeniden düzenleme işlemini yapamaz, daha sonra denetleyici bunu yapmalıdır.

Her neyse, bu durumun, kodun olası güç politikaları olan bölünmüş bir ekip tarafından yazıldığını ve alt sistem tasarımlarını yeniden canlandırmadıklarını biliyorum.

Gerçek hikaye. Senin başına gelebilirdi.

Kodun meşru olarak bir dosyaya mutlak yolla başvurması gerektiği bir örnek düşünebilir mi?

Genel istisnaları yakalamak:

try {

 ...

} catch {
}

veya

try {

 ...

} catch (Exception ex) {
}

Bölge aşırı kullanımı

Genelde, çok fazla bölge kullanmak bana sınıflarınızın çok büyük olduğunu gösterir. Bu kod parçasını daha fazla araştırmam gerektiğini bildiren bir uyarı bayrağı.

Oluşturmaya çalıştıkları soyutlamanın kötü bir şekilde anlaşıldığını gösteren sınıf adlandırma kuralları. Ya da bu bir soyutlamayı hiç tanımlamaz.

İlk dosyada bir kez gördüğüm bir VB sınıfında akla geliyor Datave ilk 30.000'den fazla satır vardı . En az yarım düzine diğer dosyaya bölünmüş, kısmi bir sınıftır. Yöntemlerin çoğu, isimleri gibi saklanan işlemlerin etrafındaki sarmalayıcılardı .FindXByYWithZ()

Daha az dramatik örneklerle bile, hepimizin, tamamen genel bir ünvan verilmiş olarak, zayıf bir tasavvuflu sınıfa 'tamamen attığımız' ve emin olduğumdan eminim.

Dilin temel işlevselliğini yeniden düzenleyen işlevler. Örneğin, bir dizenin ".length" özelliğine bir çağrı yapmak yerine JavaScript'te "getStringLength ()" yöntemini görürseniz, başınızın dertte olduğunu bilirsiniz.

#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...
#define ...

Tabii belgelerin her türlü ve ara sıra iç içe olmadan #defines