你把功能文档放在哪里以便它显示在intellisense上？

Question

我正在编写一个库，我想将文档放在我的函数中，以便它显示在intellisense中，有点像内置函数的intellisense如何显示每个参数的描述和函数本身。你怎么把文件放进去？它是通过函数中的注释还是在某个单独的文件中？

Answer 1

在函数签名上方使用XML注释。

    /// <summary>
    /// Summary
    /// </summary>
    /// <param name="param1">Some Parameter.</param>
    /// <returns>What this method returns.</returns>

GhostDoc插件可以帮助您生成这些内容。

Answer 2

要在现有方法的基础上自动生成三斜杠注释部分，只需将光标放在方法定义正上方的空行上，然后键入三个正斜杠（＆＃34; ///＆＃34 ）。 Visual Studio将自动生成与您的方法对应的三斜杠注释。它将包含摘要的占位符，每个参数（如果有）和返回值（如果有）。你只需填写空白。

我建议您不要手动编写这些描述块，而不是从一种方法复制到另一种方法。第三方工具也不是生成它们所必需的（至少在Visual Studio 2010中）。

Answer 3

“ XML文档注释（C＃编程指南） 在Visual C＃中，您可以通过在源代码中的特殊注释字段中直接包含XML标记来创建代码文档。“

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

如果您愿意，您也可以使用Sandcastle生成chm文件

http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx

Answer 4

除了XML注释，还需要启用构建文档（在项目设置中）并将生成的XML文件与程序集保持一致。