3

我正在使用 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 注释并将新的注释放在它们丢失的地方..

有谁知道如何解决这个问题？

谢谢

4

4 回答 4

2

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

  1. 尝试完全禁用 StyleCop。
  2. 仔细检查您是否禁用了 C# | 在您的自定义配置文件中重新格式化嵌入的 XML 文档注释。
  3. 在调用代码清理时，请仔细检查您是否确实选择了此自定义配置文件。
  4. 创建一个可以重现问题的示例解决方案并联系 ReSharper 支持。请参阅http://www.jetbrains.com/support/resharper/
于 2013-04-18T21:40:03.567 回答
1

我遇到了类似的问题。我使用 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.我取消选中时发现了有问题的设置，它停止搞砸我的格式。

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

于 2014-01-18T01:13:19.077 回答
1

作为另一种选择，

在 Resharper > 选项 > 工具 > StyleCop > 标题下

选择“使用单行声明标题”

于 2016-03-02T01:46:12.907 回答
0

RESHARPER > 选项 > StyleCop

关闭标题 > 将文本插入文档和文件标题

于 2013-06-07T14:54:14.763 回答