2013-04-21 39 views
2

Visual Studio/monodevelop具有非常棒的功能,可以讓您在每個函數/變量上方指定xml註釋,然後在翻轉時顯示爲該函數的描述它,點擊它等如何在外部庫中提供參考代碼中的註釋

/// <summary> 
    /// This is example for stack overflow 
    /// </summary> 
    public void Foo() 
    { 

    } 

這是很酷,但它在你的本地代碼,我怎麼能做出這些評論是在外部庫,這是在另一個項目中引用的功能僅適用(1個項目內) ,也可以在THAT項目中使用?它應該是可能的,因爲它適用於.NET程序集(當你引用一個.net庫中,你將可以看到這些描述對在庫函數)

回答

3

可以使用生成xml您的庫文件視覺工作室,檢查它here

的生成XML文檔文件屬性決定是否一個XML 文件將彙編期間生成。您可以設定 此屬性編譯頁面(Visual Basic)或建立網頁(對於Visual C#)的 項目設計。當選擇此選項,XML文檔 自動發射到一個XML文件,該文件將具有相同的 名稱作爲您的項目和.xml擴展名,Reference

+0

確定,所以這些額外的文件需要被加載的地方? – Petr 2013-04-21 17:37:22

+0

您需要將其放入相關程序集所在的目錄中。 – Adil 2013-04-21 17:39:07

2

您可以使用/doc,然後用你的組件捆綁在生成的文檔:

http://msdn.microsoft.com/en-us/library/3260k4x7.aspx

+0

這是很重要的信息,因爲例如MonoDevelop中沒有「生成XML文檔文件」,在構建選項,但可以追加/ doc的編譯器參數,+1 – Petr 2013-04-21 17:41:35