c# - 为 DLL 中的参数添加注释

Question

我在 .NET 中创建了一个 DLL，其中包括几个函数。现在我在另一个应用程序中起诉这个 DLL

我希望每当客户端使用我的 DLL 时，必须显示某种注释来显示返回类型、参数等，就像这样

我看到人们使用 XML 文件。有其他方法吗？温柔地感谢

Answer 1

您需要在成员声明之前使用注释中指定的XML 文档。

/// <summary>Some stuff here</summary>
/// <remarks>Some remarks</remarks>
/// <param name="foo">The foo to gronk</param>

然后进入您的项目属性并在“构建”选项卡中启用在您的库旁边构建一个 XML 文件。将其与您的 DLL 一起分发，Visual Studio 将显示您的内容。

Answer 2

/// <summary>
/// This method does something.
/// </summary>
/// <param name="zain">Zain to be processed.</param>
/// <returns>True if it went okay, false otherwise.</returns>

Answer 3

在方法声明的开头使用 /// ：

/// <summary>
/// This method does something.
/// </summary>
/// <param name="foo">Foo value to be processed.</param>
/// <returns>True if it went okay, false otherwise.</returns>
public bool DoSomething(int foo)
{
    if (foo > 0)
        return true;
    else
        return false;
}

Answer 4

如前所述，您可以在每个公共成员的开头添加 XML 文档：

/// <summary>
/// This is the summary for your method.
/// </summary>
public void MyMethod()
{
    /// your code here...
}

有许多工具可以在此过程中提供帮助。查看GhostDoc以生成评论，查看Sandcastle以从中创建帮助文件或网页。