是否有VS快捷方式在向方法签名添加新参数时自动更新三斜杠注释？

Question

Visual Studio的漂亮的自动记录功能允许您在方法之前键入三个斜杠('///')以自动生成xml样式的文档存根,如下所示:

    /// <summary>
    /// 
    /// </summary>
    /// <param name="bar"></param>
    /// <param name="baz"></param>
    /// <returns></returns>
    public int foo(bool bar, string baz)
    {
        return 0;
    }

如果我编辑签名并添加新参数,是否有用于更新注释的键盘快捷键,添加带<param ...>标记的新行？

更新:此功能在官方称为"智能注释编辑",其完整文档可在" XML文档注释 "(分隔符)下的"MSDN编程人员指南"中找到.没有提到任何"更新"功能,所以这个问题的答案显然是"不".

Answer 1

我还没有在 Visual Studio 中看到此功能，但在 R# ReSharper 中肯定见过（我目前运行的是 8.2 C# 版本）。

根据您的 R# 设置，您将在变量名称下看到一个红色波浪线，并附有以下说明：

 Parameter 'foo' has no matching param tag in the XML comment for Class1.Bar (but other parameters do)

然后，您可以使用 R# 选项，例如：

 Add xml-doc comments

希望这可以帮助。如果您当前不使用 R#，您会发现许多其他出色的功能/用途，并且物有所值:-)