Resharper 2016.1格式化方法文档标题(XML Doc Comments)

时间:2016-06-03 14:01:44

标签: c# resharper xml-documentation

我正在努力让Resharper以某种方式重新格式化我的XML文档评论。我想在新行上使用摘要文本,但在一行上需要其他标记。其格式与Visual Studio占位符文本相同(输入///时)。

我搜索过StackOverflow但还没找到任何东西。

如果我的解释不够清楚,这就是我的意思:

清理前:

/// <summary>This is a summary</summary>
/// <param name="object">An object</param>

清理后(目前):

/// <summary>
/// This is a summary
/// </summary>
/// <param name="object">
/// An object
/// </param>

清理后(需要):

/// <summary>
/// This is a summary
/// </summary>
/// <param name="object">An object</param>

有办法做到这一点吗?

如果失败了,有没有办法用Resharper生成的摘要文本填充Visual Studio占位符文本?

(我在Resharper论坛上发布了这个问题,但还没有回复)

1 个答案:

答案 0 :(得分:1)

目前看来Resharper目前无法实现这一目标。可以使用Agent Smith插件完成,正如Jeremy Morton在my Resharper Support post上所建议的那样。

要做到这一点:

  1. 安装Agent Smith
  2. 在Resharper选项中,在AgentSmith =&gt;下; Xml Documentation =&gt;回流和重返
    • <summary>设置为&#39;始终&#39;
    • 将其他所有内容设置为&#39; Never&#39;
  3. 保存更改。
  4. 这可以通过打开快速修复窗口(Ctrl +。)并选择&#39; Reflow&amp; Retag评论[特工史密斯]&#39;。

    它也可以设置为在整个文件中进行更改 - 在代码清理期间 - 选择&#39; Reflow&amp; Retag XML文档评论&#39;和&#39; Reflow XML文档评论&#39;选项。