«comments» etiketlenmiş sorular

Bir hatayı düzeltmek / bir CR uygulamasının bir parçası olarak koda yaptığımız her değişiklik için başlangıç ​​etiketleri, son etiketleri, açıklama, çözüm vb. Benim endişem, bu herhangi bir katma değer sağlıyor mu? Olduğu gibi, Versiyon kontrol geçmişinde her bir değişikliği izlememize yardımcı olacak tüm detaylara sahibiz? Ancak benim ipuçlarım yorumların "iyi" …

42 version-control  bug  comments  change 

Başlık numarasına dosyanın içine hata numaralarını koymak iyi bir uygulama mıdır? Yorumlar şöyle bir şeye benzeyecek: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Yararlı görünüyor, ancak kötü uygulama olarak mı kabul …

40 version-control  development-process  source-code  comments 

Sürekli olarak "yorumların modası geçmiş olma eğiliminde olduğunu" iddia eden insanları görüyorum. Mesele şu ki, kariyerim boyunca belki iki veya üç eski moda yorum gördüm. Ayrı belgelerdeki eski bilgiler her zaman olur, ancak benim deneyimlerime göre kodun eski modası geçmiş yorumları oldukça nadirdir. Kimlerle çalıştığımda şanslı mıydım? Bazı endüstriler bu …

38 comments  myth 

Programlama boyunca, kodu açıklayan bazı yorumlar ve kodu kaldıran bazı yorumlar ile biteceksiniz: // A concise description const a = Boolean(obj); //b = false; Hangisinin hızlı bir şekilde ayrıştırılması için iyi bir yöntem var mı? 3 /'ü kullanarak ve /** */açıklayıcı yorumlar için oynadım . Ayrıca vurgulamak için bir VSCode …

36 javascript  comments 

Bir yorumun, geçerli olduğu çizgiye sığmayacağını (veya gidemeyeceğini varsayalım), yorumdan önce koddan önce mi yoksa sonra mı yazmalı? Gelecekteki okuyucular nerede olursa, yorumun kapsamını en iyi şekilde anlayacaklardır. Diğer bir deyişle, çoğu programcı / senaryo yazarı nerede olursa olsun böyle yorumlar yapmıştır. Peki , çoğu programcı / script nerede bir …

34 comments 

Yorumlar genellikle programlama dillerinde ve işaretlemede nasıl ele alınır? Bazı özel biçimlendirme dili için bir ayrıştırıcı yazıyorum ve en az sürpriz ilkesini takip etmek istiyorum , bu yüzden genel sözleşmeyi belirlemeye çalışıyorum. Örneğin, bir belirteç içine gömülü bir yorum belirteçle etkileşime girmeli mi, gelmemeli mi? Genellikle şöyle bir şeydir: Sys/* …

31 parsing  comments 

Tomurcuk geliştiricilere yönelik kod yorumları yazmak için kesin bir rehber var mı? İdeal olarak, yorumların ne zaman kullanılması (ve kullanılmaması gerektiği) ve hangi yorumların bulunması gerektiğini kapsayacaktır. Bu cevap : Ne yaptığınızı yorum yapmayın, ama neden yaptığınızı. WHAT, onu desteklemek için uygun değişken adları seçerek temiz, okunabilir ve basit bir …

27 language-agnostic  comments 

Kapalı . Bu soru görüşe dayalı . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu güncelleyin, böylece bu yayını düzenleyerek gerçekleri ve alıntıları yanıtlayabileceksiniz . 5 yıl önce kapandı . Bunu SO Tavern'de sordum , bu yüzden soruyu buraya gönderiyorum. Bunun ilginç bir soru olduğunu düşündüm. (Tabii …

27 source-code  comments  coding-style  grammar 

Bu soru edildi göç o Yazılım Mühendisliği Stack Exchange'de yanıtlanabilir çünkü yığın taşması gelen. 8 yıl önce göç etmiş . Sizden kodunuzda yorum yazma konusunda herhangi bir tavsiye ve deneyim duymak istiyorum. Onları en kolay ve bilgilendirici şekilde nasıl yazıyorsunuz? Kodun bölümlerini yorumlarken hangi alışkanlıklarınız var? Belki bazı egzotik tavsiyeler? …

26 coding-style  comments 

Kapalı . Bu soru görüşe dayalı . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Soruyu güncelleyin, böylece bu yayını düzenleyerek gerçekleri ve alıntıları yanıtlayabileceksiniz . 4 yıl önce kapandı . Fonksiyonel programlamaya yeni başlıyorum ve kodumu yorumlamanın doğru yolunu merak ediyorum. Kısa bir fonksiyonu yorumlamak biraz gereksiz …

25 functional-programming  comments 

Yorumların yuvalanamayacağı yalnızca bir dilde görünmüyor. Bu sorun için iyi bir çözümünüz var mı? C / C ++ ve Java'daki bir geçici çözüm yalnızca tek satırlı yorumu kullanmaktır, ancak daha büyük bir bloğu yorumlamak imkansız hale gelir. Bunun gibi bir şeyle karşı karşıyayım: </li><!-- <li><!-- Save --> Bu yüzden yorumları …

23 java  c++  python  c  comments 

Kilitli . Bu soruya ilişkin yorumlar devre dışı bırakıldı, ancak hala yeni cevapları ve diğer etkileşimleri kabul ediyor. Daha fazlasını öğren . Bir arama yaptım ama aradığımı bulamadım, eğer bu soru daha önce sorulsaydı, lütfen bağlantıya geçmekten çekinmeyin. Bu ayın başlarında bu yazı yapıldı: http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ Özetlemek gerekirse, yorum yazmazsanız, kötü …

22 coding-standards  comments 

Kodumun büyük bir bölümünün değiştirilmesi gerektiğine karar verdiğimde, ya yanlış olduğu ya da diğer nedenlerle gerekli büyük mimari değişikliklere adapte edilmesi gerektiği için, tipik olarak yaptığım şey şu: Değiştirmem gerekebileceğini düşündüğüm tüm kodları yorumluyorum. Yorumlanan kodu TODO listemin bir türü olarak kabul ediyorum. Bu kodun yorumlanan kodunu ve uncomment bölümlerini …

21 anti-patterns  comments 

Bugünlerde yorum yapmak her zamankinden daha kolay. Java'da, yorumları sınıflara bağlamak için bazı güzel teknikler vardır ve Java IDE'leri sizin için yorum kabukları yapmakta iyidir. Clojure gibi diller, işlev kodunun kendisinde bir işlevin açıklamasını bağımsız değişken olarak eklemenize izin verir. Bununla birlikte, hala iyi geliştiriciler tarafından yazılan eski veya zayıf …

20 java  python  clojure  comments 

Bazı açık kaynak projelerinden, aşağıdaki kodlama stilini topladım void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } falseBurada ne anlama geldiğinden her zaman şüphem var. "Unut" anlamına mı geliyor, yoksa "unutma" karşılık gelen parametresine mi (yukarıdaki durumda olduğu gibi) atıfta bulunuyor ve "yanlış" ise onu reddetmek anlamına mı …

19 coding-style  comments  boolean