“//…” kod bloğunun sonundaki yorumlar} - iyi mi kötü mü? [kapalı]

Bu tür yorumların sıklıkla kullanıldığını gördüm:

function foo() {
   ...
} // foo

while (...) {
   ...
} // while

if (...) {
   ...
} // if

ve bazen bile

if (condition) {
   ...
} // if (condition)

Bu uygulamayı hiç anlamadım ve böylece hiç uygulamadım. Kodunuz çok uzunsa, bu sonun ne olduğunu bilmeniz gerekir }, o zaman belki de ayrı işlevlere bölmeyi düşünmelisiniz. Ayrıca, çoğu geliştirici aracı eşleşen brakete atlayabilir. Ve son olarak, benim için, KURU prensibinin açık bir ihlali; koşulu değiştirirseniz, yorumu da değiştirmeyi unutmamalısınız (ya da bakıcı için, hatta sizin için dağınık olabilir).

Peki neden insanlar bunu kullanıyor? Kullanmalı mıyız yoksa kötü bir uygulama mı?

Kod o kadar uzunsa, parantezinizi kolayca takip edemezseniz, kodunuzun çoğu dil için yeniden düzenlenmesi gerekir.

Bununla birlikte, geçici dillerde (PHP gibi) geçerli olabilir, çünkü koşul veya döngü yapısının başlangıcını ve sonunu ayıran büyük bir HTML bloğuna sahip olabilirsiniz.

Bu bir kod kokusu ve genellikle eski moda kod stilinden bir akşamdan kalma. İyi IDE'lerin yeniden düzenlenmesi daha zor ve şimdiki kadar yaygın olmayana kadar, bu nedenle yöntemler daha uzundu ve bu yorumlar daha iyi gezinmek için oradaydı.

Bu, birçok faktör tarafından kullanılmayan korkunç bir uygulamadır.

• Modern IDE'lerin çoğu, düzeltme işareti her iki simgede olduğunda da karşılık gelen ayracı vurgular.
• Temiz kod yazıyorsanız, yönteminizin 10 satırdan fazla olduğu bir yer nadiren bulunur.

Bu zihniyete sahip bir çok Java programcısının farkına varıyorum ve Java kodunun gerçekten kirli görünmesini sağlıyor ve odağı koddan uzaklara ve yorumlara doğru alıyor.

Son derece bu kullanılmasına karşı düşündürmektedir.

Kod yazıldığından 10 kat daha fazla okunur.

Okumayı kolaylaştırırsa yapın.

Ayrıca bunu yapan herkese, işleri daha kolay okumak için başka yollara bakmaları gerektiğini de öneririm. Diğer insanların bahsettiği yeniden düzenleme teknikleri, farklı hatlardaki parantezler, vb. Hepsi iyidir. Kodun kendi kendini yorumlaması için işleri farklı işlevlere, yöntemlere veya sınıflara bölmek de iyidir. Çoğu "ifs" i ​​ortadan kaldırmanın ve "for" döngülerini bariz yerlere koymanın, böylece bunlardan herhangi birine olan ihtiyacı ortadan kaldırmanın yolları da vardır.

Ama bazen insanlar öğreniyorlar. Bu yaptıkları bir şey ise, kodu gerçekten daha okunaklı yapan, teşvik edin ve sonra da diğer bazı uygulamaları da teşvik edin. Öğrenen insanlar, nasıl başladıklarına bakılmaksızın cesaretlendirmeyi hak eder ve bundan faydalanırlar. "Bu kötü" demek, "Bu başka şey daha iyi" demek kadar kullanışlı değildir.

Ben bu tür bir şey dolu büyük (C ++) kod tabanı var:

int Class::AccessorMethod(void)
{
    return privateValue;
}//end AccessorMethod

Bu küçük bir şey için, bu "kod kokusu" içine "kod kokusu" ötesine geçer söyleyebilirim. Özellikle açılış parantezini bulmak için kapanış parantezini tuş vuruşuyla eşleştirebileceğim bir IDE'de. Daha uzun bir yöntem göz önüne alındığında, hala tel yorumunu terminal yorumu üzerinden alacağım. Bu tür yorumlar beni rahatsız ediyor ve ben onları gürültü olarak görme eğilimindeyim.

C ++ 'da bunun hala yararlı olduğu iki tutucu vardır ve "kodunuzu ayırın" tavsiyesi gerekli değildir:

1. İsim alanları için. Bir ad alanı tüm dosyayı kapsayabilir ve bu son parantez bazen insanları atabilir, bu nedenle parantezin bir ad alanının kapatılması olduğunu belirten bir yorum eklemek yararlıdır. Şirketimdeki belirli kodlama stili için bu önemlidir, çünkü bu girintinin sadece bir dosyada yer açacağına karar verildiğinden ad alanlarını girintilemiyoruz.

2. #İfdef / #endif çiftleri için. Bazen koşullu derleme için çok fazla kod var, iç içe geçme ile kötü olabilir ve sık sık kullandığımız editör girintiyi ortadan kaldırır, bu nedenle yorumlar hızlı bir genel bakış sırasında faydalıdır.

Benim için, kodun belirttiğiniz gibi bir yorum eklemek için kafa karıştırıcı olması gerekir.

Sadece // EĞER İfadesi diyorsa. O zaman neden orada olduğunu merak etmelisin.

Brace'nizin neyi kapattığını görmenin alternatifi, açılışını yakın olanla aynı sütunda bulundurmaktır. Bunu çok daha net ve okunaklı buluyorum.

Yorum, normalde izlenmesi zor olduğunda faydalıdır, çünkü açık uzun zaman önce gerçekleşmiştir. Bu normalde sadece bir ad alanı için olmalıdır (özellikle derleme birimindeki uygulama ayrıntıları için kullanılan C ++ 'da anonim). Çoğu durumda neyi kapattığınız açık olmalıdır.

Bu, özellikle EVE gibi pencereli bir editör kullanıyorsanız, 80x24 karakter terminal pencerelerinde eski çalışma günlerinden büyük bir engel. Şimdi bile, işimin çoğunu vim kullanarak bir terminal oturumunda yapıyorum ve oturumu üç veya dört alt pencereye bölebilirim, böylece herhangi bir anda yalnızca birkaç satırı görüntüleyebilirim.

Bununla birlikte, pastırmamı birden fazla vesileyle kurtaracak olsa bile, konvansiyona asla ısınmadım. Sadece gürültü olarak görüyorum. Döngüleriniz veya koşullarınız bu kadar büyüyorsa, evet, yeniden düzenlemeye bakmak isteyebilirsiniz.

temelde bunu kullanmamanız için geçerli tüm nedenleri belirtirsiniz. Her saygın programcı bunları uygulamalıdır. Peki neden yok insanlar kullanmak? Çünkü bunu yanlış yapıyorlar ve daha iyisini bilmiyorlar.