«comments» etiketlenmiş sorular

C # XML yorumları için en iyi uygulama bir öneri arıyorum. Bir özellik oluşturduğunuzda, beklenen XML belgelerinin aşağıdaki formu olduğu görülüyor: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. /// </summary> public int ID { get; set; } Ancak mülkün imzası zaten …

19 c#  .net  programming-practices  comments 

JQuery kodunun yorumlarından birçok sayı gördüm . (Aslında, jQuery kodunda 69 sayı vardı.) Bence iyi bir uygulama olurdu, ama hiç bir kılavuz görmedim. İyi bir uygulama ise, bu uygulama için yönergeler nelerdir?

18 comments  issue-tracking 

Birkaç kişi biliyor, ama bildiğim kadarıyla popüler olanlardan değil. Yorumları yerleştirmeyle ilgili kötü bir şey var mı? Üzerinde çalıştığım (küçük) dilde blok yorumları yerleştirmeyi planlıyorum, ancak bunun kötü bir fikir olup olmadığını bilmek istiyorum.

18 language-agnostic  syntax  comments 

Kapalı . Bu soru görüş temelli . Şu anda cevapları kabul etmiyor. Bu soruyu geliştirmek ister misiniz? Bu yayını düzenleyerek gerçekler ve alıntılarla yanıtlanabilmesi için soruyu güncelleyin . 4 yıl önce kapalı . Bu tür yorumların sıklıkla kullanıldığını gördüm: function foo() { ... } // foo while (...) { ... …

18 source-code  comments 

Ekibimdeki geliştiricilerden biri, bir yöntemin imzasında HER parametre için bir javadoc yorumu yazmanın gerekli olduğuna inanıyor. Bunun gerekli olduğunu düşünmüyorum ve aslında zararlı bile olabileceğini düşünüyorum. Öncelikle, parametre adlarının açıklayıcı ve kendi kendini belgelemesi gerektiğini düşünüyorum. Parametrelerinizin ne için olduğu hemen belli değilse, muhtemelen Yanlış Yapıyorsunuzdur. Ancak, bazen bir parametrenin …

18 java  documentation  source-code  comments  maintainability 

Mağazamızdaki kıdemli geliştirici, kod her değiştirildiğinde, sorumlu programcının ne yaptığını belirten satır içi bir yorum eklemesi gerektiğinde ısrar ediyor. Bu yorumlar genellikle// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Revizyon kontrolü için TFS kullanıyoruz ve bana göre bu tür yorumlar satır içi gürültü yerine check-in notları olarak …

17 coding-standards  comments 

Oldukça bazı kod tabanlarında aşağıdaki gibi şeyleri belirten yorumları görebilirsiniz: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Birkaç sorum var, ama hepsi birbiriyle ilişkili. Bir programın yorumlarında SO sorularına bağlantı koymak doğru mu? // We're now mapping from the "sorted-on column" to original indices. // // …

16 comments 

NotImplementedExceptionHenüz yazmadığınız kodları atmak kötü bir uygulama mıdır ? Muhtemelen TODO yorumları daha güvenli kabul edilir mi?

15 .net  comments  coding  exceptions 

Burada ne sorulduğunu söylemek zor. Bu soru belirsiz, belirsiz, eksik, aşırı geniş veya retoriktir ve mevcut haliyle makul bir şekilde cevaplanamaz. Bu sorunun yeniden açılabilmesi için açıklığa kavuşturulması konusunda yardım için yardım merkezini ziyaret edin . 8 yıl önce kapalı . Sadece meraktan, yorumlara izin vermeyen bir dilin daha fazla …

15 comments 

Şu anda olduğu gibi, bu soru Soru-Cevap formatımıza uygun değil. Yanıtların gerçekler, referanslar veya uzmanlık tarafından desteklenmesini bekliyoruz, ancak bu soru muhtemelen tartışma, tartışma, oylama veya genişletilmiş tartışma talep edecektir. Bu sorunun çözülebileceğini ve muhtemelen yeniden açılabileceğini düşünüyorsanız, yardım için yardım merkezini ziyaret edin . 7 yıl önce kapalı . …

15 comments 

Varlık, İş Mantık ve Veri Erişimi sınıflarım için bilgilendirici sınıf dokümantasyon formatı arıyorum. Buradan aşağıdaki iki biçimi buldum Biçim 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: Description: ///----------------------------------------------------------------- Biçim 2 …

15 c#  documentation  comments 

Çatışma belirteçlerini düşünün. yani: <<<<<<< branch blah blah this ======= blah blah that >>>>>>> HEAD Beni bu soruyu göndermeye motive eden özel durumda, sorumlu ekip şubemize yukarıdan bir birleşmeyi tamamlamıştı ve bazı durumlarda bunları yorum olarak, yeni olan şeylerle ilgili bir tür belge olarak bırakmıştı. çözüldü. Derlenmiş bir durumda bıraktı, …

14 version-control  comments  coding-style 

Hesaplamalı geometri ve grafiklere ve bu tür konulara değinen bir sürü (öncelikle c ++ ve javascript) kodları yazıyorum, bu yüzden görsel diyagramların problem çözme sürecinin vazgeçilmez bir parçası olduğunu gördüm. Hemen şimdi "oh, bir şekilde bir kod parçasına elle çizilmiş bir diyagramı yorum olarak ekleyebilirsem harika olmaz mıydı" dedim ve …

14 productivity  code-reviews  comments  workflows  image-manipulation 

Biz 20 yaşında eski bir kod temeli bazı refactoring yapıyoruz, ve meslektaşım ile kod (plsql, java) yorum biçimi hakkında bir tartışma yaşıyorum. Yorumlar için varsayılan bir biçim yoktur, ancak çoğu durumda insanlar yorumda böyle bir şey yapar: // date (year, year-month, yyyy-mm-dd, dd/mm/yyyy), (author id, author name, author nickname) and …

13 java  c#  programming-practices  code-quality  comments 

Olanları tanımlamak için ek, teknik olarak gereksiz yerel değişkenler kullanmak iyi bir stil midir? Örneğin: bool easyUnderstandableIsTrue = (/* rather cryptic boolean expessions */); if(easyUnderstandableIsTrue) { // ... } Teknik yük söz konusu olduğunda, derleyicinin bu ek hattı optimize etmesini bekliyorum. Ancak gereksiz bir kod şişmesi olarak mı kabul edilir? …

12 coding-style  comments