r#:停止触摸ghostdoc XML注释的代码清理

本文关键字：注释 代码 XML ghostdoc 触摸 | 更新日期: 2023-09-27 18:09:44

我使用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注释，并把新的它们丢失的地方。

有人知道怎么解决这个问题吗?

谢谢

r#:停止触摸ghostdoc XML注释的代码清理

很可能你做错了什么，或者你在ReSharper或StyleCop中遇到了一个bug。你应该:

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

我也遇到过类似的问题。我使用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.找到了令人讨厌的设置，我选中了它，它就不再破坏我的格式了。

您应该能够对自己的问题采用类似的方法，将"Parameters"替换为您的问题

作为另一个选项，

在Resharper> Options> Tools> StyleCop> Headers

选择"使用单行声明头"

RESHARPER> Options> StyleCop

关闭Headers>在文档和文件头中插入文本

相关文章：