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

时间:2017-01-19 12:39:36

标签: resharper xml-documentation

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

自: -

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

要: -

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

我已取消选中 XML Doc Comments 部分下提及换行符的所有内容无效但无法找到其他相关部分?

1 个答案:

答案 0 :(得分:4)

在Visual Studio菜单中“Resharper”&gt; “选项”转到“工具”&gt; “StyleCop”并选中“为声明标题使用单行”框。

Screenshot (link to imgur.com)

然而,这将适用于所有文档元素,而不仅仅是param,如:

/// <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>

如果你想要它比我更怀疑,我怀疑你需要在那之后手动调整它。