C# içindeki Web İstemci Yazılım Fabrikası (WCSF) kullanarak bir ASP.net web uygulamasında çalışırken bu ikilemde karşılaştım ve aynı diğer platform ve diller için de geçerli olabilir. Benim durumum şu şekildedir:Arabirim ve sınıf yöntemleri için yorumlar nasıl farklı olmalıdır
Ben WCSF paradigmasına dayalı olarak her web sayfası/kullanıcı kontrolü için bir I Görünüm arayüzünü tanımlayan amdaha sonra sayfa sınıfı temelde tanımlanan yöntemlerin her uygulayıcı, ben Görünüm arabirimini uygulamak zorunda arayüz. Yöntem seviyesine xml-dökümantasyonu eklemeyi denediğimde, temel olarak, hem arayüz metodu hem de uygulama sınıfındaki karşı taraf için aynı yorum içeriğini tekrarladım.
Bu yüzden sorum şu: arabirim yöntemindeki belge içeriği ile karşılık gelen sınıf yöntemi arasında önemli bir fark olması gerekir mi? Farklı yönlerde ya da başka bir şey üzerinde durmalılar mı?
Biri bana, arayüz yöntemi yorumunun "ne" yapması gerektiğini söylemesi gerektiğini ve sınıf yöntemi yorumunun "nasıl" olduğunu söylemesini söyledi. Ama daha önce bir yerde okumayı hatırlıyorum. Yöntem seviyesi yorumu, yöntemin uygulamacılar için bir endişe olmamasından ve yöntemin değişebileceğinden, yöntemin uygulama detayını, sadece "ne" yapması gerektiğini söylemelidir.
Bu gerçekten korktuğum cevap :), ama sanırım haklısın. Her iki yerde de aynı içeriği tekrarlayarak giyiyorum. Copy-n-paste hızlandırmaya yardım etti, ama bunu yaptığım şey beni kandırıyor ... – hongliang
@hongliang: Bir arayüz uyguluyorsanız, GhostDoc'un bir kopyasını alın - bu, uygulama sınıfı için XML doc yorumlarını doldurmak ve yorumları arayüzden kopyalamak için tek bir tuş kullanmanıza izin verecektir. Çok kaygan: http://submain.com/products/ghostdoc.aspx –
Vay canına! Tam olarak istediğim şey bu. Teşekkürler! – hongliang