C＃コメントの文字をエスケープするにはどうすればよいですか？

今日、C＃のコメントで文字をエスケープする方法がわからないことに気付きました。ジェネリックC＃クラスをドキュメント化したいのですが、<および>文字をエスケープする方法がわからないため、適切な例を書くことができません。私は使用する必要が<あり>ますか？実際のドキュメントのコメントを読みやすくしたいので、そのような場合は気に入らないので、サンプルコードを読み取るためになんらかのコードドキュメントを生成する必要はありません。

XMLコメントで文字をエスケープする必要がある場合は、文字エンティティを使用<する必要があるため<、質問のようにとしてエスケープする必要があります。

エスケープの代わりにCDATA、セクションを使用して同じ効果を得ることができます。

あなたが指摘したように、これは見栄えの良いドキュメントを生成しますが、読むための恐ろしいコメント...

プレーンC＃コメントでは、任意の文字を使用できます（*/コメントを/*で開始した場合、またはコメントをで開始した場合は改行文字を除く//）。XMLコメントを使用している場合は、CDATAセクションを使用して「<」および「>」の文字を含めることができます。

C＃でのXMLコメントの詳細については、このMSDNブログの記事を参照してください。

例えば

/// <summary>
/// Here is how to use the class: <![CDATA[ <test>Data</test> ]]>
/// </summary>

「実際のドキュメントのコメントを読みやすくしたい」とおっしゃっていました。同意する。

開発者は、自動生成されたドキュメントを熟読するのではなく、ほとんどの作業をコードに費やしています。これらはチャートのようなサードパーティのライブラリには最適ですが、すべてのコードを処理する社内開発には適していません。ここで、MSFTが開発者をより良くサポートするソリューションを考え出していないことに、ちょっとショックを受けました。コードを動的に展開/折りたたむ領域があります...インプレースコメントレンダリングの切り替え（生のテキストと処理されたXMLコメントの間、または生のテキストと処理されたHTMLコメントの間）ができないのはなぜですか？メソッド/クラスのプロローグコメント（赤いテキスト、斜体など）にいくつかの基本的なHTML機能が必要なようです。確かに、IDEはインラインHTMLコメントを盛り上げるために少しHTML処理の魔法を働かせることができます。

私のソリューションのハックソリューション： '<'を "{"に変更し、 '> "を"} "に変更します。これは、特定の例を含む一般的な使用例のコメントの説明に含まれているようです。不完全ですが、実用的です読みやすさの問題（および「<」を使用したときに発生するIDEコメントの色付けの問題）

C＃XMLコメントはXMLで記述されるため、通常のXMLエスケープを使用します。

例えば...

<summary>Here is an escaped &lt;token&gt;</summary>

この問題に住みやすい解決策は、2つの例を含めるだけであることがわかりました。1つは読みにくいXMLコメントのエスケープ文字付きバージョン、もう1つは従来の//コメントを使用した読みやすいバージョンです。

シンプルですが効果的です。

{...}を使用するよりも、≤...≥を使用する方がよい（以下の等号、以上の等号、UnicodeのU2264およびU2265）。下線付きの山括弧のように見えますが、それでも間違いなく山括弧です！そして、あなたのコードファイルに数バイトを追加するだけです。

U2280とU2281を試してみてください-Unicode 文字のリスト（数学演算子のセクション）からコピーして貼り付けてください。