如何添加在.NET的DLL

如何添加XML文檔的方法在C＃中自帶的.NET函數定義爲我的功能的信息。如何添加在.NET的DLL

例

Guid.NewGuid（）;

當用戶按下。關鍵他得到了有關NewGuid功能的幫助。

我有一個類GetDocsInfo其中有像getDocTag功能，我需要一個類似的功能，是否有任何元數據類型的事情，我需要添加就像屬性

來源

2011-10-05 Nitin Bourai

[檢查此鏈接。] [1] [1]：http://stackoverflow.com /問題/ 641364/C-文檔發電機 – Boomer

你所說的只是顯示的智能感知。這是從功能或屬性，即評論的元數據提取：

/// <summary> 
/// My details here.... 
/// </summary> 
public void MyFunction() 
{ 
    ... etc ... 
}

如果你把編輯光標放在你想要記錄的功能，上面的線，然後鍵入連續三個正斜槓，Visual Studio將隨後自動爲您填充評論部分，您只需插入詳細信息即可。

或者，您可以使用名爲GhostDoc的Visual Studio插件，該插件在您的上下文菜單中爲您提供一個選項來自動記錄該功能 - 它確實可以確定文檔應該基於參數和名稱的功能。

來源

2011-10-05 05:29:21 slugster

我已經添加了總結///但它沒有顯示，我已經構建庫太 –

我的功能也很多參數超過10個時，我選擇的任何功能，它顯示所有參數的列表並顯示此函數返回的內容 –

您需要添加XML文檔類成員。當您在Visual Studio中輸入代碼時，只需在您的成員定義中按下/鍵三次，就會生成一個您可以編輯的框架。

/// <summary> 
/// What your function does. 
/// </summary> 
/// <param name="paramterName">Description of parameter</param> 
public void Method Name(string paramterName) 
{ 
}

來源

2011-10-05 05:28:07 Maheep

我不知道如果我理解正確的，因爲它在C＃中，但如果你正在使用C＃做一個很平常的事，三斜槓可以用於爲函數生成文檔：

/// <summary> 
/// Adds two numbers 
/// </summary> 
/// <param name="x">First number</param> 
/// <param name="y">Second number</param> 
/// <returns>The sum of specified numbers</returns> 
private int Sum(int x, int y) 
{ 
    return x + y; 
}

來源

2011-10-05 05:28:53 A9S6

通過上述烏爾函數或類寫入 '///'

https://stackoverflow.com/questions/641364/c-documentation-generator

來源

2011-10-05 05:31:27 Boomer

如何添加在.NET的DLL

回答

相關問題