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

別のオプションとして、

[Resharper] > [オプション] > [ツール] > [StyleCop] > [ヘッダー] の下

「宣言ヘッダーに単一行を使用する」を選択します

于 2016-03-02T01:46:12.907 に答える
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 に答える
0

RESHARPER > オプション > StyleCop

ヘッダーをオフにする> ドキュメントとファイル ヘッダーにテキストを挿入する

于 2013-06-07T14:54:14.763 に答える