在DLL中为参数添加注释

Question

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

我希望每当客户端使用我的DLL时，必须显示一些注释，显示返回类型，参数等等。

我看到人们使用XML文件。有什么替代方法吗？ 谢谢你的温柔

Answer 1

您需要在成员声明之前使用评论中指定的XML documentation。

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

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

Answer 2

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

/// <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 3

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

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

有许多工具可以帮助您完成此过程。查看GhostDoc以生成评论，并Sandcastle用于创建帮助文件或网页。

Answer 4

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