Yalan söyleyen kodu aramalı mıyız?

Bu, bir cevaptaki bir tartışmaya ve bu sorunun yorumlarına atıfta bulunuyor : Sektördeki dokümantasyondan kaçınma nedir? . Cevap, "kod yalan söyleyemez" ve dolayısıyla dokümantasyon yerine gidilecek yer olması gerektiğini iddia etti. Birkaç yorum "kod yalan olabilir" işaret etti. Her iki tarafta da, en azından kısmen, belgelerin ne kadar kötü ve uygunsuz bir şekilde ele alındığından dolayı gerçek vardır.

Mevcut herhangi bir belgeyle karşılaştırarak yalancı kod arayışında mıyız? Yoksa genellikle yapması gereken şey için en iyi kaynak mı? Çevik kod ise, yalan söyleme olasılığı daha düşük mü yoksa bu kod hiç yalan söylemiyor mu?

Layman'ın sözleriyle:

Evet , yalancı kodu aramalı ve gerçeği söylemesini sağlamalısınız. Ancak bunu dokümanlarla karşılaştırarak değil.Yalan belgelerin tespiti için bir yöntem olurdu.

Kodun yalan söyleyebileceği birkaç yol var, bunlardan sadece birkaçını anlatacağım:

• Asla çalışmayan kod blokları, çünkü asla karşılanmayan koşullar. Kod size ne kadar yaptığı hakkında yalan söylüyor.
• Gereksiz karmaşıklık katan kod, sorunun gerçekten ne kadar karmaşık olduğu konusunda yatar.
• Hiçbir adlandırma kuralı olmayan kod, çünkü gerçekten yaptığı şeyden farklı bir şey yaptığını düşünmenize yol açar.

Ne kadar kısa olursa, o kadar az yatar. Bu apaçık ortada.

Kod ne kadar karmaşıksa, o kadar şeffaf olur. Yani daha az yatıyor.

Gizli sözdizimi hileleri çok yalan söylüyor. Net, adım adım algoritmaları tercih edin. Daha az yalan söylerler.

İyi bir statik kod analiz aracı yalan söyleyen kodu bulmanıza yardımcı olabilir.

Ayrıca iyi bir otomatik test bataryası, kodu gerçeği söylemeye zorlar.

Kod yalan söyleyemez.

Kodda ne var, programınız şu anda ne yapıyor - hangi belgeler, KG veya müşteri ne olursa olsun. Özellikle kodunuz bir süre serbest bırakıldıysa ve sahada bulunuyorsa, beklenen davranışlar göz ardı edilmemelidir.

Kod kesinlikle yanlış olabilir . İsimlendirilmesinde veya organizasyonunda kesinlikle yanıltıcı olabilir. Kesinlikle okunamaz olabilir.

Ancak, kodunuzun ne yaptığının gerçeğinin kaynağını istiyorsanız, yapması gerekeni değil, yapmak için tasarlandığı şeyi değil, ne yaptığını düşündüğünüzü değil ... aslında ne yaptığını bilmeniz gerekiyorsa, koda gidin.

Birkaç soru soruyorsun.

Yalan söyleyen kod arayışında mıyız?

Elbette!

[Kod] ile mevcut dokümantasyon karşılaştırılmalı mıdır?

Diğer yanıtlarda belirtildiği gibi, bu asla zarar veremez, daha sık olarak bu , kodda değil , belgelerde sorun bulmanıza neden olur .

Yoksa [kod] genellikle yapması gereken şey için en iyi kaynak mıdır?

Her zaman ne için en iyi kaynaktır edilir yapıyor. Kodun ne yapması için en iyi kaynak, farklı şeyler olabilir (bunların bir kombinasyonu), ana olanlar:

• Kodun kendisi;
• Telefon kodu;
• Bu koddaki yorumlar;
• Belgeler;
• Birim testleri;
• Entegrasyon ve regresyon testleri;
• Programcı;
• Son kullanıcı;

"En iyi" kaynak (veya bunların kombinasyonu) hangisi sizin durumunuza bağlıdır.

Çevik kod ise, yalan söyleme olasılığı daha düşük mü yoksa bu kod hiç yalan söylemiyor mu?

"Agile code" ile ne demek istediğinizden emin değilim, AFAIK "agile" genellikle kodlama sürecini ifade eder. Eğer "çevik bir programlama sürecinde oluşturulan kod" demek varsayalım o zaman hala yalan söyleyebiliriz düşünüyorum . Şelale tarzı projelerde oluşturulan kodla karşılaştırıldığında yalan söyleme olasılığı öznel bir konudur (kişisel olarak büyük bir bağlantı olduğunu düşünmüyorum).

Dipnot
Yukarıdaki tüm kodu varsayımı altında olduğunu olabilir bu temel (biraz yapmacık olsa da) örnek olduğunu yalan ve:

public int DivideByTwo(int input) 
{
    return input / 3;
}

Bu "kod yalanları" diyebilirim sadece bir örnek, @ user61852 birkaç diğerleri (ulaşılamaz kod, sorun karmaşıklığı eşleşmeyen kod karmaşıklığı, kötü adlandırma) ve ben çok daha fazlası olduğunu düşünüyorum. Vikipedi yalanların biraz iyi bir özetine sahiptir , birçoğu kod bulunabilir.

Birisiyle tartışıyorsanız, diğer kişinin "kod yalan söyleyemediğini" ifade etmediğinden emin olun , "kod ne yaparsa yapsın". Özünde buradaki diğer kişi, "yalan" için bir tanım kullanarak, "kod yalan söyleyemez" ifadesini bir aksiyom / temel gerçek olarak ilan edebilecek şekilde tanımlamaktadır. Bu durumda muhtemelen aksiyomu ile anlaşmak en iyisidir.

if (x > 5) {
  doSomething();
} else {
  doADifferentThing();
}

"Yalan" kelimesinin teknik olarak uygun olup olmadığını tartışabilirsiniz, ancak bu kod açıkça x'in bazen 5'ten büyük ve bazen olmayacağına işaret etmektedir. Tam programa bakarsanız ve bu işlevin yalnızca tek bir yerde çağrıldığını ve x'in her zaman sabit 6'ya ayarlandığını keşfederseniz, bu bir yalandır.

Dahası, derleyici bunu fark etmiş olabilir ve bu kod bloğunu basitçe

doSomething()

DoADifferentThing, programınızda başka bir yerde çağrılmazsa, programdan tamamen kaldırılabilir.

Eğer diliniz assertüretim yapılarında kapalı olan bir tür dili destekliyorsa , her assertifade potansiyel olarak bir yalandır. Daktilo, yalan olabilecek başka bir iddiadır.