«comments» etiketlenmiş sorular

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ı . Sürüm kontrolü yorumları için diğer kullanıcılar ne yapar / önerir - geçmiş veya şimdiki zaman? yani Değiştirilen …

12 comments  source-code 

Yaklaşık on yıldır gelişen oldukça büyük bir özel kod tabanım var. Ben phpDocumentor kullanmıyorum ama docblock bölümleri kullanmak açık kaynak projelerinde oldukça standart haline geldiğinden ben de depomda tüm genel yöntemler için docblock yazma benimsemiştir. Çoğu blok, tüm parametreler ve dönüş türü için küçük bir açıklama ve yazım karakterleri içerir. …

12 php  comments 

Bir "spagetti-code" projesi üzerinde çalışıyorum ve hataları giderirken ve yeni özellikler uygularken, kod birim test edilebilir hale getirmek için bazı yeniden düzenleme yapmak. Kod genellikle o kadar sıkı bağlanır veya karmaşıktır ki, küçük bir hatayı düzeltmek birçok sınıfın yeniden yazılmasına neden olur. Bu yüzden yeniden düzenlemeyi bıraktığım kodda bir yere …

11 refactoring  comments 

Normal ifadeleri yorumlamak için yaygın uygulamalar var mı: RegEx'in farklı kısımlarına atıfta bulunan satır içi yorumlar veya tüm ifadeler için genel yorum?

11 documentation  coding-style  comments 

Bugün bir meslektaşımla konuşuyordum. İki farklı proje için kod üzerinde çalışıyoruz. Benim durumumda, kodum üzerinde çalışan tek kişi benim; Onun durumunda, düzenli olarak (8-12 ayda bir) gelip giden co-op öğrencileri de dahil olmak üzere, aynı kod tabanında birden fazla kişi çalışır. Yorumlarıyla liberal olduğunu ve her yere koyduğunu söyledi. Onun …

11 coding-style  team  comments 

Java'da kullanımdan kaldırılmış bir sınıfı tanımlamak için bir yorum eklemek için en iyi yolu bilmek istiyorum. Başka bir programcının bu sınıfın ne olduğunu bilmesine yardımcı olan sınıfın en üstüne eklenen önceki yorumu kaldırmalı mıyım yoksa yorumu aşağıya eklemeliyim?

11 java  code-quality  api  comments 

Kendim için küçük komut dosyaları yazarken, kodlarımı yüksek yorumlarla yığarım (bazen ben koddan daha fazla yorum yaparım). Konuştuğum bir çok insan, kişisel olmasına rağmen bu senaryoları belgelemem gerektiğini söyledi, böylece onları satarsam hazır olurdum. Ancak yorumlar bir tür dokümantasyon değil mi? Bu olmaz: $foo = "bar"; # this is a …

11 documentation  comments 

Dokümantasyon için XML yorumları gerektiren bir hayranıydım. O zamandan beri iki ana nedenden dolayı fikrimi değiştirdim: İyi kod gibi, yöntemler de kendinden açıklamalı olmalıdır. Uygulamada, çoğu XML yorumu ek değer sağlamayan yararsız gürültüdür. Çoğu zaman genel yorumlar oluşturmak için GhostDoc'u kullanırız ve işe yaramaz gürültü ile kastediyorum: /// <summary> /// …

10 .net  programming-practices  development-process  documentation  comments 

Ben düzgün belgelenmiş kodun bir savunucusuyum ve bunun olası dezavantajlarının farkındayım . Bu, bu sorunun kapsamı dışındadır. Visual Studio'da IntelliSense'i ne kadar sevdiğimi göz önünde bulundurarak herkese açık XML üyeleri ekleme kuralını izlemeyi seviyorum. Ancak benim gibi aşırı bir yorumcunun bile rahatsız ettiği bir fazlalık biçimi vardır. Örnek olarak List.Exists …

10 documentation  comments  intellisense 

Eşittir, karşılaştırmak vb. Aşağıdaki kodu göz önünde bulundurun. /** * This method compares the equality of the current object with the object of same type */ @Override public boolean equals(Object obj) { //code for equals } Şirketim yukarıdaki gibi yorum girmek için madalyalar. Yukarıdaki Javadoc yorumu gerekli mi? Eşit yöntemin …

10 java  comments 

Robert C. Martin tarafından Temiz Kod okuyorum ve ifade TILTbazı kod örneklerinde açıklanamaz görünüyor. Örnek (bu arada Java dilinde): ... public String errorMessage() { switch (status) { case ErrorCode.OK: // TILT - Should not get here. return ""; case ErrorCode.UNEXPECTED_ARGUMENT: return "Unexpected argument"; case ErrorCode.MISSING_ARGUMENT: return "Missing argument"; ... } …

9 java  clean-code  comments  conventions 

Bir projeden ayrılmak üzereyim ve gitmeden önce patronum benden belge kodu göndermemi istedi (çok iyi belgelemedim). Bu büyük bir mesele değil, proje çok karmaşık değil. Ama belgelerimde "XYZ hattında böyle ve böyle bir şey olduğuna dikkat edin" demek istediğim yerler buluyorum. Bu durumda, tek bir kod satırının eklenmesi veya silinmesi …

9 documentation  comments 

Javadoc'u KURU bir şekilde yazmak istiyorum. Ancak Javadoc hakkındaki oracle belgesi , aşırı yük yöntemi yorumunda tekrar aynı şeyi yazdığını söylüyor. Tekrardan kaçınamaz mıyım?

9 documentation  comments  dry  javadocs 

Ş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ı . …

9 comments 

Bu aptalca bir soru olabilir, ama bir süredir kafamın arkasındaydı ve başka hiçbir yerde iyi bir cevap bulamıyorum. Sadece bir tane olsa bile her parametreyi bir açıklama ile açıkça listelememiz gerektiğini söyleyen bir öğretmenim var. Bu bir çok tekrarlamaya yol açar: double MyFunction(const int MyParam); // Function: MyFunction // Summary: …

9 documentation  comments  coding-style