你把功能文档放在哪里以便它显示在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

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

我建议你不要试图手工编写这些描述块而不是从一种方法复制到另一种方法.第三方工具也不是生成它们所必需的(至少在Visual Studio 2010中).