«comments» etiketlenmiş sorular

Pek çok insan "yorumlar 'nedenini açıklamalı, ama' nasıl 'değil" iddiasında. Diğerleri "kodun kendi kendini belgelemesi gerektiğini" ve yorumların kıt olması gerektiğini söylüyor. Robert C. Martin, (kendi sözlerime göre yeniden ifade edilmiştir) sık sık "yorumların kötü yazılmış kod için özür dilediğini" iddia ediyor. Sorum şu: Tanımlayıcı bir yorumla karmaşık bir algoritmayı …

236 programming-practices  documentation  comments 

Ekip üyelerimden biri kodunda yorum yapmaktan kaçınıyor. Kodu kendiliğinden belgelenmiyor ve diğer programcılar kodunu anlamakta zorlanıyorlar. Ondan kodunu yorumlamasını birkaç kez istedim, ancak daha sonra yapacağına dair mazeret veya iddialarda bulundu. Kaygısı, yorum eklemek çok zaman alacak ve projeleri geciktirecek. Kurallarını doğru bir şekilde belgelemeye ikna etmesi için kendisine hangi …

182 teamwork  team  comments 

Hayata kritik bir yazılım üreten dükkanlarda çalıştım ve kodu okunaklı ve potansiyel olarak hayat kurtarmayı amaçlayan yorum kuralları ile uğraştım. Tecrübelerime göre, gereksinim bir kontrol listesinden atılmak için bir beyin ölümü angaryası haline geliyor ve anlaşılabilir kod yazmaya odaklanmama yardımcı olmuyor. Ayrıca, hakem değerlendirmecilerimin kodun anlaşılmasını nasıl kolaylaştıracağı konusunda benimle …

142 coding-standards  comments  standards  naming-standards  standardization 

Bir iş arkadaşım kod içi yorumların herhangi bir kullanımının (yani, javadoc tarzı yöntem veya sınıf yorumları değil) kod kokusu olduğuna inanıyor . Ne düşünüyorsun?

100 comments  anti-patterns 

Burada genç geliştirici. Şu anda şirketimin büyük bir müşterisi için bir web uygulamasında tek başıma çalışıyorum. Geçen ay başladım. Müşteri, her yazılım projesinde yorumların en az% 25'ini ister. Önceki uygulamaların kodunu kontrol ettim ve işte benim gözlemlerim: her dosya bir yorum bloğuyla başlar (paket, en son güncelleme tarihi, şirketimin adı …

96 project-management  comments  client-relations  hierarchy 

Oldukça büyük bir proje üzerinde çalışıyorum ve bunun için bazı çeviriler yapmakla görev aldım. Tercüme edilmemiş tonlarca etiket vardı ve ben kodu araştırırken bu küçük kodu buldum //TODO translations Bu bana kendinize (ve başkalarına) bu yorumların anlamını düşündürdü, çünkü çoğu geliştiricinin belirli bir kod parçasını aldıktan sonra yaptıklarını hissediyordum ve …

86 documentation  comments 

Yeni meslektaşlarımla yorum yapma konusunda bazı tartışmalar yapıyorum. İkimiz de Temiz Kod'u seviyoruz ve satır içi kod yorumlarından kaçınılması ve sınıf ve yöntem adlarının yaptıklarını ifade etmek için kullanılması gerektiği konusunda gayet iyiyim. Ancak, ben sınıfın amacını açıklamak çalışır ve aslında ne temsil küçük sınıf özetleri ekleyerek büyük bir hayranıyım …

83 comments  clean-code 

Aşağıdaki kodu yazdım: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Burada bir yorum satırı var. Ama bence ifve arasındaki farkın ne olduğunu açıkça ortaya koyarak kodu …

83 documentation  comments 

Öncelikle, bu soruda kaynak kod yorumlamanın iyi ya da kötü olup olmadığı konusunda polemikten uzak durmak istiyorum. Sadece insanların NEDEN, NE veya NASIL olduğunu söyleyen yorumlar hakkında konuştuklarında ne anlama geldiklerini daha net anlamaya çalışıyorum. Sık sık "Yorumlar size NEDEN söylemelidir; kodun NASIL olduğunu söylemelidir" gibi yönergeler görüyoruz. Soyut bir …

78 documentation  comments 

Subversion'un (işyerinde kullandıklarımız) komisyonlar hakkında yorum yapılmasını gerektirecek şekilde yapılandırılabileceğini biliyorum, ancak bunu basitçe açacak bir güç pozisyonunda değilim. Bunu biliyorum benim çabuk taahhüt nedenlerini kavramak, çok faydalı olduğunu, çünkü benim kaydedilmesini yorumlama nedeni ise sadece hafıza-cimnastiği olarak vardır. Ancak, bu her zaman aldığım iki yanıtla mücadele etmek için yeterli …

78 version-control  comments 

Patronum tarafından öğretiliyorum (okulu yeni bitirdim ve biraz programlama tecrübesi olan birini istiyordu, bu yüzden beni bu şirketin uzmanlığı konusunda eğitmeyi seçti) ve ASP.NET MVC uygulamaları, bazı HTML ve CSS ile çalışmaya başladı. . Bana verdiği web tasarımı konusunda iyiyim (açıklama olmadan anlaşılması oldukça kolaydır). Ancak örneğin bana ASP.NET MVC …

72 comments 

XXXBir yorumda gördüğünüzde insanlar genelde ne anlama gelir ? Bazen, böyle bir yorum göreceğim: # XXX - This widget really should frobulate the whatsit Elbette, yorumun ne anlama geldiğini söyleyebilirim, ancak XXX genel olarak ne anlama geliyor? "Bu bir hack" mı, yoksa "Belki de daha sonra tekrar ziyaret etmeliyiz" mi? …

72 comments  coding-standards 

Sadece kendimi yazdığım bazı (arkaik Visual Basic 6.0) kodunda şu yorumu yazarken buldum: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Bilinçli olarak neden “biz” i yorumlarımda kullandığımdan emin değilim. Şüpheliyim, çünkü kodun içinde birisinin, her bir satırdaki tüm komutları …

63 comments  coding-standards 

Arka fon Sıfır kesinti süresi dağıtımını uygulamak isteyen bir ekipte çalışıyorum. Bunu başarmak için mavi / yeşil bir dağıtım stratejisi kullanmayı planlıyoruz. Araştırma yaparken anladığım şeylerden biri de veritabanı değişiklik yapmanın ne kadar karmaşık olduğu. Bir sütunu yeniden adlandırmak gibi basit bir işlem tamamlanana kadar 3 tam serbest bırakma döngüsü …

51 continuous-integration  deployment  comments  continuous-delivery 

Birisi bir keresinde tüm yöntemlerimizi /// <summary>yorum blokları (C #) ile belirtmemiz gerektiğini söyledi, ancak bunun nedenini açıklamadı. Onları kullanmaya başladım ve beni biraz rahatsız ettiklerini gördüm, bu yüzden kütüphaneler ve statik yöntemler dışında onları kullanmayı bıraktım. Hacimlidirler ve onları güncellemeyi her zaman unutuyorum. /// <summary>Kodunuzda yorum blokları kullanmak için …

49 c#  comments