Bir kodlama standartları belgesi yararlıdır. Bu var en çok kimsenin çok fazla sorun olmadan her şeyi hatırlıyorum o kısa yeterli zaman kullanışlı ve herkes çok fazla ağrıya neden değil yaptığında.
Kuruluşunuzdaki kodu girintiye almayı veya adları büyük harfle kullanmayı veya döngülerinizi nasıl uygulayacağınızı veya kodunuzu nasıl yorumlayacağınızı o kadar önemli değil; yardımcı olan kısım herkesi, herkesinkiyle aynı görünen kodlar yazmaya teşvik etmektir.
- Diş tellerinin nerede olması gerektiği ve bir başkasının koduna her baktığınızda böyle bir beklentinizi yeniden ayarlamak için bir dakika harcamak zorunda kalmaz.
- Aynı dosyada birkaç farklı kod stiline sahip olmaktan kaçınır.
- Belki de en önemlisi, yazılı bir standarda sahip olmak, kod incelemeleri sırasında kodlama uygulamaları hakkında tartışmalardan kaçınır.
Yine, standartların ne olduğu basit, basit bir standarda sahip olmak kadar önemli değildir. Bu nedenle, tüm geliştiricilerinizi bir odaya koyun ve standartların ne olması gerektiği konusunda tartışmalarına izin verin. Bu toplantı süresiz olarak devam edebilir, bu yüzden kurallar:
- Toplantının sonunda karar verilmeyen herhangi bir şey yönetici tarafından kararlaştırılacaktır.
- Toplantı iki saat sonra veya biri bağırmaya veya ağlamaya başladığında hangisi önce gelirse biter.
- Tüm standart (makul tip boyutunda!) Bir kağıda veya iki kağıda sığacaktır, sadece kesinlikle gerekliyse çift taraflı.
Birini evlat edinmeyi düşünün | başkasının | standartları kendi kodlama standartları toplantınız için bir başlangıç noktası olarak veya toplantıdan tamamen kaçınmanın bir yolu olarak.
Anlaşmaya varıldıktan sonra, geliştiriciler polisi kendileri yapabilmelidir (ve beklemelidir). Standarttan zaman zaman sapma çok önemli olmamalı (ve haklı bile olabilir), ancak standart lehine favori bazı kişisel stilleri terk etmeyi reddetmek, sızan su boruları ile ofise derhal taşınma ile sonuçlanmalıdır. .
Demian Brecht tüy bırakmayan aletlere işaret ediyor. Bunlar bir kodlama standartları belgesinin mükemmel bir tamamlayıcısıdır. Kodlama stili standartlarına bağlı kalmak sadece iyidir ; bu kadar önemli tehlikeli uygulamaları ile ilgili standartlar kodlama için sopa. Yazar dışındaki hiç kimse, her kod satırının stil standardını karşıladığını kontrol etmeyecektir, ancak olası hataları otomatik olarak yakalamak için ekibinizin iş akışına bir tiftik aracı oluşturmayı kesinlikle düşünmelisiniz. Ek olarak, aracın kendisi kabul edilen uygulamaları kodlayabilir, böylece hepsini kodlama standartlarında tek tek listelemeniz gerekmez; aracın yapılandırmasını belirtmeniz yeterlidir.
Not: "Kodlama standartları" fikri programlamaya özgü değildir. "Kodlama standartları" birçok alanda, bazen bir kuruluşta, daha çok bir endüstri veya mesleğin tamamında kullanılır. Bazı örnekler:
Her durumda (ve diğer pek çok kişi), yetkili bir uygulayıcı, beklenen standarda uymayan "kodu" kolayca anlayabilir. Neden bu kadar çok sektör bir derleyici tarafından ayrıştırılması gerekmeyen belgeler için ayrıntılı gereksinimler yazmaya devam ediyor? Çünkü stil önemlidir . Standart bir tarzda bilgi sunmak, okuyucunun tamamen içeriğe odaklanmasını sağlar, okumayı daha hızlı hale getirir ve anlaşmaya yardımcı olur ve hataları azaltır.