SORU
5 Mayıs 2009, Salı


C arayüzü ve uygulama açıklamaları eşitlemek için yollar#

Bir arabirimi ile uygulaması arasında senkronize yorumlar için otomatik bir yolu var mı? Şu anda ikisini de kaydediyorum ve el ile eşit tutmak istemez.

GÜNCELLEME:

Bu kodu göz önünde bulundurun:

interface IFoo{
    /// <summary>
    /// Commenting DoThis method
    /// </summary>
    void DoThis();
}
class Foo : IFoo {
    public void DoThis();
}

Böyle bir sınıf oluşturun:

IFoo foo=new Foo();
foo.DoThis();//comments are shown in intellisense

Burada yorum gösterilmez:

Foo foo=new Foo();
foo.DoThis();//comments are not shown in intellisense

<inheritDoc/> etiketi tamamen Kumdan Kale içinde belgeleri oluşturur, ama ıntellisense araç ipuçlarında işe yaramıyor.

Fikirlerinizi paylaşın lütfen.

Teşekkürler.

CEVAP
5 Mayıs 2009, Salı


Bu Microsoft kumdan kaledeki kullanarak kolayca (veya NDoc) inheritdoc etiket yapabilirsiniz. Resmen belirtimi tarafından desteklenen değil, ama özel etiketler mükemmel kabul edilebilir, ve gerçekten Microsoft kumdan kaleyi oluştururken NDoc bu (ve bir veya iki diğer etiket) kopyalamak için seçti.

/// <inheritdoc/>
/// <remarks>
/// You can still specify all the normal XML tags here, and they will
/// overwrite inherited ones accordingly.
/// </remarks>
public void MethodImplementingInterfaceMethod(string foo, int bar)
{
    //
}

Here yardımcı tam olarak kullanımı açıklayan kumdan kaledeki GUI Builder Yardım Dosyası, sayfa.

(Tabii ki, bu özellikle senin sorun bahseder gibi, ama tam olarak öyle görünüyor, yine de ne arıyorsun.) "senkronizasyon değil

Bir not olarak, bu bazı insanlar her zaman türetilen ve uygulanan sınıflarda yorumlar yeniden düşünmelisin olduğunu düşünmüşümdür ama bence çok adil bir fikir gibi geliyor. (Aslında benim kitaplıkları belgeleyen kendim yaptım ve herhangi bir sorun olursa olsun, seni görmedim.) Hemen hemen her zaman yorum hiç farklı bir nedeni yok, bu yüzden neden sadece miras ve kolay yolu değil mi?

Düzenleme:Sizin güncelleme ile ilgili, kumdan kaleyi de senin için bunu da halleder. Kumdan kaleyi çıkış dağıtmak anlamına gelir giriş için kullandığı gerçek XML dosyası, modifiye edilmiş bir versiyonubu Değiştirilmiş Sürümükütüphane ile birlikte yerine doğrudan ıntellisense yorumlar. yani Visual Studio tarafından inşa yanı sıra Dokümantasyon dosyası (KİM, ne) vb.

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Jon Reed

    Jon Reed

    14 AĞUSTOS 2006
  • Khan Academy

    Khan Academy

    17 Kasım 2006
  • TheOtherMau5

    TheOtherMau5

    6 Mart 2012