Question

我正在使用GhostDoc创建我的XML注释，我对格式非常满意。我使用以下格式（c＃）

    /// <summary>
    /// Creates new client.
    /// </summary>
    /// <param name="uri">The URI.</param>
    /// <param name="param">The param.</param>
    /// <returns></returns>

使用R＃7.1.1中的代码清理它重新格式化我的xml注释，它甚至会在缺少的地方插入新的xml注释，这真的很烦人。有没有办法阻止这种情况。

我已经为代码清理创建了我自己的配置文件，并且禁用了所有内容（甚至是stylecop设置）并且我进行了代码清理，并且确实需要重新格式化我的xml注释并将新的注释放在缺少的位置。

任何人都知道怎么解决这个问题？

由于

Answer 1

很可能你做错了什么或者你在ReSharper或StyleCop中遇到了错误。你应该：

尝试完全禁用StyleCop。
仔细检查您是否已禁用C＃|在自定义配置文件中重新格式化嵌入的XML文档注释。
在调用代码清理时，请仔细检查您确实选择了此自定义配置文件。
创建可以复制问题的示例解决方案并联系ReSharper支持。请参阅http://www.jetbrains.com/support/resharper/

Answer 2

我遇到了类似的问题。我使用GhostDoc和R＃Code Cleanup继续转向

/// <summary>
/// Defines the entry point of the application.
/// </summary>
/// <param name="args">The arguments.</param>

进入这个

/// <summary>
/// Defines the entry point of the application.
/// </summary>
/// <param name="args">
/// The arguments.
/// </param>

这令人气愤，因为我Reformat embedded XML doc comments取消了选择。我终于在ReSharper->Options->Code Cleanup->StyleCop->1611: Element Parameters Must Be Documented.找到了违规设置，我取消了这个，并且它停止了我的格式化。

您应该能够针对自己的问题采用类似的方法，将“参数”替换为您的问题。

Answer 3

作为另一种选择，

在Resharper下＆gt;选项＆gt;工具＆gt; StyleCop＆gt;标题

选择“将单行用于声明标题”

Answer 4

RESHARPER＆gt;选项＆gt;了StyleCop

关闭标题＆gt;将文本插入文档和文件标题

R＃：停止接触Code Cleanup上的ghostdoc XML注释？

4 个答案: