如何在 Visual Studio 中配置方法的摘要注释

Posted 2023-04-12

【中文标题】如何在 Visual Studio 中配置方法的摘要注释

【英文标题】：How to configure summary comment on method in Visual Studio

【发布时间】：2019-01-16 01:00:19

【问题描述】：

在 Visual Studio 中的方法上方键入“///”时，它会生成 XML 摘要。 例如：

    /// <summary>
    /// 
    /// </summary>
    /// <param name="par1"></param>
    /// <param name="par2"></param>
    /// <returns></returns>
    public string Foo(int par1, string par2)
    
        return "";
    

是否有可以停止添加以下行的设置？

/// <returns></returns>

【问题讨论】：

除了声明 void 方法，我不知道

为什么不直接删除呢？

@RBarryYoung，有些人忘记做的额外步骤。但主要是我自己的好奇心:)

@Roman，由于您的方法返回一个字符串，并且 XML 文档注释默认有 行，如果它是一个 void 方法，则不会创建此行。据我所知，没有这样的设置可以自动删除它，给您带来的不便，敬请见谅。

【参考方案1】：

经过一些研究和几个cmets，我不相信有这样的设置或功能来自定义自动添加

//<returns></returns>

这适用于 VS2017 及更早版本。也许这将在未来某个时候成为一个功能。