問題タブ [xml-comments]

XMLコメントにある例外がコールチェーンのどこかで処理されているかどうかを確認できるC＃コード分析ツールはありますか？

特に処理する必要のある例外のみがxmlコメントであると仮定すると、かなり便利です。

次のコードを使用して XML ファイルを読み込もうとしています。

ファイルに次のようなコメントが含まれている場合:

XmlSerializer は次のようなエラーを返します

予期しないノード タイプのコメントです。ReadElementString メソッドは、単純なコンテンツまたは空のコンテンツを持つ要素でのみ呼び出すことができます

ファイル内のこのコメントを削除すると、正常に動作します。

どこに問題があるのか​​ わかりません。アイデアはありますか？

このXMLについて考えてみましょう。

コメントアウトする方法はありますMouseDoubleClick="item_DoubleClick"か？この試みは失敗します：

xml コードのコメントにファイル参照のタグはありますか? ファイルは SQL スクリプト ファイルです。このようなものよりも良い方法があるかどうか疑問に思っています

XMLコメントをどこに適用すべきかに興味があります。より一般的なXMLコメントをインターフェースに配置し、より説明的なコメントを実装クラスに配置する必要がありますか？このような：

<param>簡単にするために含めませんでした。

それはコメントの良い習慣ですか、それとも別の方法がありますか？インターフェイスのコメントをスキップしますか？

私は次のものを持っていますが、XML コメントでこれを適切に参照する方法がわかりません。

私の推測では ですが<seealso cref="M:MyNamespace.FooExtensions.FooX{T}(this Nullable{T} foo)"/>、それが正しいかどうかは 100% ではありません。誰か知っていますか？

ああ、私は ECMA PDF 文書を持っていますが、それでもそれを理解することはできません。

APIドキュメントの生成に使用されるツールが部分クラスに対するXMLスタイルのコメントを持つことを処理する標準的な方法はありますか？基本的に、結果のヘルプドキュメントが壊れないように、部分的なクラス/メソッドにどのようにコメントする必要がありますか？この質問は、使用するツールによって異なる可能性があります。その場合、最も重要な2つのツールは次のとおりです。

• XMLドキュメントを作成するためのVisualStudioの組み込みメソッド
• マイクロソフトのサンドキャッスル

XMLドキュメントをファンキーに見せたくないのはすべてです

基本的に、完全修飾xmlを使用することが本当に必要なのはいつですか（あるとしても）。リファレンスを参照してください。

また、.NETFrameworkオブジェクトへの参照についてはどうでしょうか。

完全に適格なアイテムは常にMicrosoftのSandcastleが物事を適切にリンクできるようになることを理解していますが、すべてが完全に適格である必要がありますか？

補足：MicrosoftSandcastleは.NETFrameworkヘルプファイルにリンクできますか、それとも参照して時間を無駄にしています<see cref="T:System.Collections.Generic.ICollection{T}"/>か？

コード：

私の推測は次のとおりです。

確信はないけど。ECMA ガイドは区別に役立たなかったので、私の推測が正しいという保証を探しているのだと思います。

///クラス、フィールド、メソッド、またはプロパティを超えると、VisualStudioがXMLスタイルのコメントの作成を開始することを理解しています。

ただし、名前空間やライブラリのXMLコメントを追加するにはどこに行けばよいですか...

例えば：

• .NETFrameworkクラスライブラリ
  • System.Collections名前空間
    1. System.Collections名前空間
    2. System.Collections.Concurrent名前空間
    3. ..。

それらのページが手動で作成されたのか、それとも適切な場所に追加されたXMLスタイルのコメントを介して自動的に作成されたのかわかりません。