Yazım / dilbilgisi ile ilgili hataları birinin kodunda mı belirtmeliyim? [kapalı]

Bir iş arkadaşının kodunu incelerken, fonksiyon isimlerinde bazı yazım hataları ile fonksiyon ve değişken isimlerinde 'doesUserHavePermission ()' yerine 'doesUserHasPermission ()' gibi gramer hataları ile karşılaştım.

Bunları ona mı göstermeliyim yoksa bunları farkederek çok bilgili miyim?

Yazım ve dilbilgisi hataları ile Kod olan unmaintainable .

• İnsanlar kötü dilbilgisini hatırlamayacaklar, bu yüzden fonksiyonu yazıldığı gibi çağırmaya çalışacaklar ve böylesi hatalar oluyor.

• Nasıl yazıldığını bilmiyorsanız, koddaki bir şeyi öğrenemezsiniz.

• Dilbilgisi / yazım yapan çoğu insan bunu tutarsız bir şekilde yapar, bu nedenle yanlış adlandırmada birçok hata ortaya çıkarır. Bu özellikle, kullanımdan önce açıkça belirtilmesi gereken değişkenler gerektirmeyen dillerde sorun yaratır, çünkü yeni bir yazım ekleyebilir ve kodunuz berbat olduğunuzu bildirmek için bir taşlama durmasına gelmez.

Bu sorunların düzeltilmesi, bilgiçlik taslak değildir, başkalarının istihbarat, okuryazarlık, vb. Düşünceleri için zorunlu değildir (bu büyük bir yan etkidir); kaliteyi ve bakım kodunu yazmakla ilgilidir .

Evet kesinlikle. Dilbilgisi doğru ise adı hatırlamak daha kolaydır. Adı ve gramer hatalarını hatırlamaya çalışmak tamamen başka bir şey.

Bunları resmi bir kod incelemesinde kusurlar olarak göstermeyin. Bunun yerine, bir girişi işaretleyin ve onunla özel olarak onlar hakkında konuşun. Bu konuda mümkün olduğunca diplomatik olun, sadece "Hey, dikkatimi çeken bir şey ve gerçekten böyle bir şeyle ilgilenen insanlara rastladım, programcının dikkatsiz ve özensiz görünmesini sağlıyor."

Bu kod ise, bir müşteri görecek, kesinlikle düzeltilmesi GEREKİR. Beğenin ya da beğenmeyin, şirketinizin ünü yansıtır.

Verdiğiniz örnek için, UserHasPermission olarak başladığından şüpheleniyorum ve bir başkası ona yerel uygulamanın UserBlahBlah () yerine, UserBlahBlah () olduğunu söyledi ve sadece dilbilgisi değişimini gözden kaçırdı.

Kendin değiştir.

Umarım "sahiplik" kodunun bir sorun olmadığı bir ortamdasınızdır. Projeye kaynak kontrolü ile erişebiliyorsanız, içeri girin ve kendiniz düzeltin. Aynı tür dilbilgisi veya yazım hatalarını tutarlı bir şekilde yapan belirli bir iş arkadaşınız görürseniz, bunu belirtmek isteyebilirsiniz, ancak bu, ilişkinize, kişinin ana dili İngilizce olup olmadığına ve genel olarak alıcı olup olmadığına bağlı olacaktır. Ama bunu yapmaya karar verip vermeme, sadece sessizce git ve düzeltme yap. Bunu her zaman yapıyorum, bir yazım hatası görürsem, özellikle bir yöntem imzasında veya kamu malında, sadece düzeltirim. Bazen bir yorumda bir yazım hatası düzeltme cazibesine bile dayanamıyorum, ama bu sadece benim :)

Ben anadili İngilizce olmayan, aslında Hollandalı olan bir geliştiriciyim ve eğer biri bana gramer veya imla hatası yaparsa aldırış etmem. Bu şekilde İngilizcemi sürekli geliştirmeye devam edebiliyorum. Ve tüm kaynak kodunuzdaki tüm hataları düzeltmek kesinlikle zor değil. Basit bir Perl betiği, bir klasördeki tüm dosyalar arasında dolaşmak için kolayca yazılabilir. Belki de sed ile yapılabilir? Bilmiyorum.

Bu yüzden kesinlikle başkalarının kodunda dilbilgisi veya yazım hatası olduğunu işaret edeceğim, ancak sadece söylediklerimin doğru olup olmadığından kesinlikle emin olursam.

Sanırım burada, HTTP protokolündeki HTTP yönlendirme başlığının “yönlendirme” olarak yanlış yazıldığını söylemeye değer (ve onunla birlikte yaşamalıyız / onunla yaşamayı öğrendik) :)

Dilbilgisi hataları içeren kodun elde edilemez olduğunu söyleyen diğer cevapları kabul ediyorum.

Ayrıca birkaç şey eklemek istiyorum:

• Kod, genellikle çok iyi İngilizce konuşamayanlar tarafından yazılır ve / veya İngilizce, anadilleri değildir. Gözden geçirdiğiniz bir kodda dilbilgisi hatası varsa, bu, iş arkadaşınızın bu hatayı yaptığı anlamına gelmez. Belki de sadece bir web sitesinden kopyala yapıştır.
• İngilizce iş arkadaşınızın anadili değilse, ona bu hatayı anlatması iyi ya da çok kötü bir fikir olabilir. Fransa'dan geldiğimde İngilizce’de yaptığım hatalar hakkındaki düşüncelerimi hep memnuniyetle karşılıyorum, çünkü gelecekte bunlardan kaçınabilmemin tek yolu; Öte yandan, onlara yaptıkları dilbilgisi hatalarını anlatırsanız, gerçekten incinmiş hisseden birçok insan tanıyorum.
• John R. Strohm'un dediği gibi, asla halka açık yapmayın. İnsanların çoğu bununla gerçekten sinirlenecek.

Dahili yazım denetleyicili bir IDE kullanmanızı öneririm. IntelliJ Idea, Java programları için harika bir iş çıkarır. Yalnızca işlev adlarında değil, kullanıcının görebileceği istisna mesajlarında yakaladığı birçok yazım hatası da vardır. Yazım hatalarıyla dolu mesajlar üreten bir program pek fazla güven vermez.

Ben sadece yaparım

• programın kullanımını etkiler
• programın doğruluğunu etkiler
• Yazarın düzeltilmek istediğini açıkça biliyorum.

Bir not olarak, işlev adlarınız dilbilgisine sahip olacak kadar uzunsa, muhtemelen çok uzun olurlar. Verilen örnekte, userHasPermission işlevini çağırır ve "dilbilgisini" kodunuza taşır, şöyle bir şey olur:

if userHasPermission() ...

Bu aynı zamanda projemde bir LOT olur (doğal olarak İbranice, Rusça veya Arapça konuşan insanlar tarafından doldurulur), ancak daha yüksek bir seviyeye bile - çoğu zaman, sözlüğün çevirisi için ne gibi bir terim kullandığını belirten bir kod görüyorum. yazarın aklında ne vardı ve onların anlamı ile ilgisi yok ...

Şahsen, çok sık gerçekleştiğinde ve projeye katılmadan önce bile kodu yazan birçok ekip üyesi tarafından, onu görmezden gelme eğilimindeyim çünkü önemli değil.

Ancak, uzun süre önce yazılmış kod veya yorumlarla aynı dosyada bazı işler veriyorum ve yazım hataları varsa, bunları çok fazla çalışmadığı için düzeltirim.

Altın Kural Uygulanır

Başkalarına, onların sana yapmalarını sağlayacak şekilde yapın.

Başkalarının bu tür şeylere sırt üstü dönmelerini istiyorum, bu yüzden başkalarına yardım ederim. Nazik ve destekleyici olmak sizin lehinize uzun bir yol kat edebilir.

Diğer pek çok iyi programlama uygulamasında olduğu gibi, programlarda yazım konusunda bir politika uygulamanın tek nesnel, politik olmayan ve etkili yolu ön-işlem sürecinin bir parçası olarak otomatikleştirmektir. Otomasyon, amaç için kendi aracınızı yazmanız gerekse bile sizi çok fazla şikayetten kurtaracaktır.

Bu kodda küçük bir hatadır, ancak bir hatadır. Bulduğun herhangi bir hata gibi davran. Politikam her zaman ortak çalışanlarımın yetkin olduğunu varsaymak ve aksi ispat edene kadar onlara bu şekilde davranmaktır.

Tek bir hata varsa, düzeltip kontrol edebilirim. Eğer bir kalıpsa, bu çalışana bu düzeltmeleri incelemesini sağlayabilirim. İyi bir kodlayıcı olduklarını düşündüğünüzü bilmelerini sağlayın, ancak bunun iyileştirilmesi iyi olacak bir şey olduğunu söyleyin. Yine de böyle bir şey için büyük bir anlaşma yapabileceğimi sanmıyorum.

Büyük bir sorun gibi görünmediğiniz sürece, bu işçiyi egoya sokmadan gelişebilecekleri bir konuma koymak kolay olmalıdır.

userPermission () belki de? -

Karşılaştığım en son konu, sınıf adı vurgulanarak yazıldığından, vurgulanmayan genel bir arama sonuçları sorunuydu. Lekelenmek çok karanlık bir böcek.

Emin olun, yazım hatalarını kontrol etmek için zamanınızı boşa harcamayın. Bunu CI'nizde otomatikleştirmek için bir araç kullanın. Net'te fxCop bunu yapabilir ...

Bu, büyük ölçüde hataların ne olduğuna, ne kadar yaygın ve ne kadar kötü olduklarına ve aslında bunun ne kadar iyi niyetli bir hata olup olmadığına ya da sadece nasıl söyleyeceğinize bağlı değildir.

Bazı salaklar 5 dakikalık bir kod incelemesini yarım saate çıkardığı için şahsen dayanamıyorum çünkü her şeyin nasıl yapılacağına karar vermesini istiyor ve tüm yorumlar sadece kürekleri içine sokmayı sevdiği için yeniden yorumlanmasını istiyor. "Veri nesnelerinin yüklenmesi" ifadesinin "Veri nesnesi yükleyici bileşeni şimdi ilgili veri nesnelerini veri nesnesi depolama bileşeninden yükleyecektir" olarak değiştirilmesi gerekmediğini söylüyor .

/ rant :)