.net - 如何为 .NET DLL 中定义的函数添加信息

Question

如何为 .NET 函数中的 c# 方法添加 XML 文档。

例子

Guid.NewGuid();

当用户按下 . 关键他得到了关于函数 NewGuid 的帮助。

我有一个 GetDocsInfo 类，它具有 getDocTag 之类的功能，我需要类似的功能，是否需要添加任何元数据类型的东西，就像属性一样

Answer 1

您所说的只是所显示的智能感知。这是从函数或属性的注释元数据中提取的，即：

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

如果您将编辑光标放在要记录的函数上方的行上，然后键入三个连续的正斜杠，Visual Studio 将自动为您填充注释部分，您所要做的就是插入详细信息。

或者，您可以使用一个名为GhostDoc的 Visual Studio 插件，它在您的上下文菜单中为您提供了一个选项来自动记录函数 - 它可以根据参数和函数名称确定文档的内容是合理的。

Answer 2

您需要为班级成员添加 XML 文档。当您在 Visual Studio 中键入代码时，在关于您的成员定义的行中按 / 键三次，将生成一个您可以编辑的骨架。

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

Answer 3

我不确定我是否理解正确，因为它在 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;
}

Answer 4

通过在你的函数或类上面写'///'

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