2010-02-03 26 views
8

如何編寫一個類,以便在其他項目中引用dll的人可以看到屬性和方法描述?如何記錄一個c#dll

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

不工作,也不做

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

你的第二個* *爲我工作。 – 2010-02-03 15:29:20

+0

也許我錯過了一些東西,但是xml註釋適用於我。 – 2010-02-03 15:30:09

+0

如果引用該類的項目在相同的解決方案中,則第二個示例可以正常工作。我正在編譯該類作爲DLL並引用此DLL。該DLL似乎不保存任何屬性或摘要信息。 – James 2010-02-03 15:41:17

回答

14

在Visual Studio:

項目 - >屬性 - >建設 - >檢查 「XML文檔文件」。

有關詳細信息,請參閱XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files

+0

這是否意味着我需要使用DLL來分發XML並將它們引用?有沒有什麼辦法可以讓DLL中的所有信息? – James 2010-02-03 15:42:05

+0

不,該XML註釋不是程序集中任何元數據的一部分。 – jason 2010-02-03 16:33:58

+0

如何讓它們成爲元數據的一部分? – James 2010-02-03 16:43:28

1

DescriptionAttribute提供的描述是在屬性網格肯定可見,它有無關的代碼編輯器。

對於XML評論可用,你必須generate an XML documentation file並與您的程序集一起運送。

1

您是否爲第二種情況構建了XML documentation file

項目屬性 - >建設 - > [輸出] XML文檔文件

1

第二個應該工作(摘要),請務必在項目屬性選擇(建設 - >輸出)XML文檔文件。