2011-10-05 56 views
0

如何添加XML文档的方法在C#中自带的.NET函数定义为我的功能的信息。如何添加在.NET的DLL

Guid.NewGuid();

当用户按下。关键他得到了有关NewGuid功能的帮助。

我有一个类GetDocsInfo其中有像getDocTag功能,我需要一个类似的功能,是否有任何元数据类型的事情,我需要添加就像属性

+0

[检查此链接。] [1] [1]:http://stackoverflow.com /问题/ 641364/C-文档发电机 – Boomer

回答

2

你所说的只是显示的智能感知。这是从功能或属性,即评论的元数据提取:

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

如果你把编辑光标放在你想要记录的功能,上面的线,然后键入连续三个正斜杠,Visual Studio将随后自动为您填充评论部分,您只需插入详细信息即可。

或者,您可以使用名为GhostDoc的Visual Studio插件,该插件在您的上下文菜单中为您提供一个选项来自动记录该功能 - 它确实可以确定文档应该基于参数和名称的功能。

+0

我已经添加了总结///但它没有显示,我已经构建库太 –

+0

我的功能也很多参数超过10个时,我选择的任何功能,它显示所有参数的列表并显示此函数返回的内容 –

0

您需要添加XML文档类成员。当您在Visual Studio中输入代码时,只需在您的成员定义中按下/键三次,就会生成一个您可以编辑的框架。

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

我不知道如果我理解正确的,因为它在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; 
}