2013-04-18 30 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>頁眉

選擇 「使用單線條的聲明標題」