2013-04-18 34 views
3

我正在使用GhostDoc创建我的XML注释,我对格式非常满意。我用下面的格式(C#)R#:停止触摸代码清理的ghostdoc XML注释?

/// <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注释并放置新的他们丢失的地方..

任何人都知道如何解决这个问题?

感谢

回答

2

最有可能你正在做的事情错了,或者你已经打了一个错误或者在ReSharper的或了StyleCop。您应该:

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

关于 “尝试完全禁用了StyleCop”,你有没有任何超出OP所尝试的建议? [相关搜索](http://www.bing.com/search?q=turn+off+StyleCop&go=&qs=n&form=QBRE&pq=turn+off+stylecop&sc=3-17&sp=-1&sk=)让我想到禁用所有StyleCop规则(这是我认为OP的描述意味着)将做到这一点。也许卸载StyleCop帮助消除过程将是最好的?否则,在我看来,当然需要禁用StyleCop设置的正确级别(即所有这些设置)。 – J0e3gan

+1

@ J0e3gan不幸的是,我不是StyleCop的专家,但我已经处理了由StyleCop引起的某些“奇怪的ReSharper错误”。这并不是说StyleCop不好,但每个人都可以犯一个错误,我需要确定它实际上是我的错误。这就是为什么在处理格式错误时,处理格式错误的第一个原因是要求用户完全摆脱StyleCop。禁用规则是不够的。也许有临时卸载StyleCop的选项(对于ReSharper你可以去Tools - > Options - > ReSharper - > Suspend),或者OP可能需要临时卸载StyleCop。 –

+1

理解 - 完全有道理。我也不是StyleCop专家,但是我发现'csproj'文件更改为在给定项目中禁用它 - 对于这种类型的疑难解答以及其他可以在项目级别禁用StyleCop的情况有帮助。一个旧的MSKB [文章](http://support.microsoft.com/kb/969475?wa=wsignin1.0)解释说,添加' false'到项目文件的全局配置部分将禁用该项目的StyleCop。我检查了它(使用StyleCop 4.7),它工作得很好。 – J0e3gan

0

的ReSharper>选项>了StyleCop

关闭头>插入文本文档和文件头

1

我有一个类似的问题。我用GhostDoc和R#代码清理不停地转动这个

/// <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.找到了违规设置,我没有选中它,并停止了我的格式化。

你应该可以按照类似的方法处理你自己的问题,用你的问题代替“参数”。

+0

我发现它是SA1611,SA1615和SA1617。 – Stephen

0

作为另一种选择,

在ReSharper的>选项>工具>了StyleCop>页眉

选择 “使用单线条的声明标题”