resharper - StyleCop for Resharper - 插入方法标题,如何禁用 <param> 标记后的换行符

标签 resharper xml-documentation

在添加方法 header 文档时,如何阻止 StyleCop for Resharper(或 ReSharper 本身)在开始 param 元素标记之后和结束标记之前添加换行符。

来自:-

/// <param name="name">
/// The name.
/// </param>

致:-

/// <param name="name">The name.</param>

我已取消选中 XML 文档注释 部分中提到换行符的所有内容,但没有任何效果,但找不到其他相关部分?

最佳答案

在 Visual Studio 菜单“Resharper”>“选项”中,转到“工具”>“StyleCop”,然后选中“使用单行声明标题”框。

Screenshot (link to imgur.com)

但这将适用于所有文档元素,而不仅仅是参数,例如:

/// <summary>The send error.</summary>
/// <param name="errorId">The error id.</param>
/// <param name="type">The type.</param>
/// <param name="message">The message.</param>

与以下内容相比,当未选中该框时:

/// <param name="errorId">
/// The error id.
/// </param>
/// <param name="type">
/// The type.
/// </param>
/// <param name="message">
/// The message.
/// </param>

如果您想要它比这更自定义,我怀疑您需要在此之后手动调整它。

关于resharper - StyleCop for Resharper - 插入方法标题,如何禁用 <param> 标记后的换行符,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/41742041/

相关文章:

resharper - StyleCop,优点/缺点

c# - 向 Visual Studio XML 文档添加不同的默认和自定义标记

VB.NET:如何在 xml 文档中引用通用类和方法

visual-studio-2010 - 禁用 VS 2010 格式粘贴 Razor 但不是 c#

c# - DateTimeFormatInfo.CurrentInfo 怎么可能为空

asp.net-mvc - 删除Layout将默认为_ViewStart,那么为什么找不到节名称?

c# - 使用 SandcaSTLe : Refering to enum value using <see> 记录

c# - 如何将文件夹级文档添加到 C# 程序集中?

c# - C#同步接口(interface)和实现注释的方法

c# - 为什么resharper建议const,静态操作?