2010-02-03 12 views
8

Bir sınıfı nasıl yazarım, özellik ve yöntem açıklamaları dll'ye referans veren diğer projelerdeki kişiler tarafından görülebilir mi? Bir C# dll belgesini nasıl kaydederim?

[Description("My age in years attribute")] 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 

çalışmak, ne

/// <summary> 
    /// My age in years attribute 
    /// </summary> 
    public int Age 
    { 
     get { return 0; } 
     set { } 
    } 
+0

İkinciniz * benim için çalışıyor. –

+0

Belki bir şey özlüyorum, ama xml yorumları benim için çalışıyor. –

+0

İkinci örnek, sınıfı referans alan projenin aynı çözüm içinde olup olmadığını gösterir. Sınıfı bir dll olarak derliyorum ve bu DLL'ye başvuruyorum. DLL, öznitelik veya özet bilgilerin herhangi birini korumak için görünmüyor. – James

cevap

14

:

Projesi -> Özellikler -> Yapı -> "XML Belgeleri Dosyası" kontrol edin.

Daha fazla bilgi için bkz. XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files.

+0

Bu, XML'i DLL ile dağıtmam ve her ikisine de başvurmam gerektiği anlamına mı geliyor? DLL'de tüm bilgilere sahip olmanın bir yolu var mı? – James

+0

Hayır, XML yorumları, derlemedeki hiçbir meta verinin parçası değildir. – jason

+0

Onları meta verilerden nasıl ayırırım? – James

1

DescriptionAttribute sağlanan açıklama kesin Mülkiyet Izgara görünür yapar ve kod editörü ile hiçbir ilgisi yoktur etmez.

XML yorumlarının kullanıma sunulması için generate an XML documentation file ürününe sahip olmanız ve derlemenizle birlikte göndermeniz gerekir. Visual Studio

1

İkinci durumunuz için XML documentation file'u kurdunuz mu?

Proje özellikleri -> [Çıktı] XML Belgeleri dosyası

1
ikinci çalışması gerekir

(özet), proje Özellikleri seçtiğinizden emin olun (Derleme - -> Çıktı) XML Belgeler Dosya Oluşturma> .