問題タブ [xml-comments]

重複の可能性:
C# の <seealso> タグでメソッド オーバーロードへのクレフを作成する方法は?

個々のメソッドではなく、このようなものを指すように、コードに XML コメントを付けるにはどうすればよいですか? ComputeHash オーバーロード

cref基本的に、MSDN と同じようにメソッド オーバーロード ページを参照するには、何を入力すればよいでしょうか。

基本的に、私は次のものを持っています: <see cref="NotifyCollectionChangedEventArgs"/>XML コメントのタグを参照してください。ReSharper は、あいまいな参照であると述べており、絶対パスとして指定することを提案しているので、<see cref="System.Collections.Specialized.NotifyCollectionChangedEventArgs"/>代わりに使用しますが、それでもあいまいな参照であると言っています。同じ名前空間に同じ名前のクラスが 2 つあると何が起こっているのかわかりませんか??

これがReSharperの問題として浮上している理由を知っている人はいますか? このマシンにはまだ Sandcastle が搭載されていないため、Sandcastle に対してこれをテストして問題が発生するかどうかを確認していませんが、問題が発生するかどうかは疑問です。

直接的な答えが見つからないように見える問題があります。私は数人の友人とゲーム エンジンを構築する最終段階にあり、この時点でコメントを簡素化して、チームに参加したい開発者にとって読みやすく有用なものにすることを検討しています。Visual Studio 2010 を使用しているので、埋め込まれた XML コメントは完璧なツールのように思えました。私たちが抱えている唯一の問題は、私たちのエンジンが基づいているグラフィック ライブラリが同じ考えを持っているように見え、XML のようなコメント スキーマも使用していることです。残念ながら、彼らが XML コメントをコンパイルするために使用したツールの構文は、Visual Studio で使用されたものと似ていないため、Visual Studio がコメントをプロジェクトの XML 出力ファイルにレンダリングしようとすると、私たちのコード。要するに、クラスとドキュメントの XML コメント出力ファイルのみを生成するように強制する、Visual Studio/VC++ で設定できるコンパイラ パラメータまたはオプションはありますか? どうもありがとう。

vsdoc documentation のこれらのガイドラインに従って、特定の型の配列に対してインテリセンスを適切に機能させることができませんでした。問題をデモするコードを次に示します

MyTypearrayOfMyType[0]のインテリセンスを取得する必要がありますが、そうではありません。また、for-in ループを試して、正しいインテリセンスが表示されるかどうかを確認しましたが、そうではありません。arrayOfMyTypeには適切なインテリセンスがあることに注意してください。それを からにArray変更すると、そのための正しいインテリセンスが得られますが、例でコメントされているようなタイプではありません。ArrayMyTypeArrayMyType

現時点では、sp1 より前の vs2010 にしかアクセスできないため、パッチが適用されたバグであるかどうかはわかりません。

誰か教えてくれませんか

• vsdoc xml コメントを間違って書いています
• その行で MyType のインテリセンスを取得することを期待することについて、私は正しいかどうか
• 上記のスニペットのインテリセンスは vs2010 sp1 で動作します

Visual Studioでは、xmlコメントをメソッド/クラスに追加してドキュメントを提供できます。http://msdn.microsoft.com/en-us/magazine/cc302121.aspxを参照してください。

Visual Studioは、これらのxmlコメントからファイルを生成してエクスポートするため、確実にアクセスできます。

私の質問は、プログラムが実行時にxmlテキストにアクセスできるようにするクラスがありますか？（力ずくの方法はエクスポートされたファイルを解析することだと思いますが、それはきちんとした解決策ではありません）

これを実行したい理由は、より大きなプログラム用の一種のヘルパープログラムを作成しているためです。そのため、xmlコメントを画面に出力したいと思います。リフレクションを通じてプロパティ名を取得しているので、名前をクラスにフィードバックしてxmlドキュメントを取得する方法はありますか？

すでに検索してみましたが、何も見つかりませんでした。私はそれをひどく言い回しているかもしれません。これは可能ですか？

重複の可能性:
XML コメントが WCF サービスに表示されない

WCFExtras のおかげで、生成された .wsdl ファイルに WCF メソッドの XML コメントが表示されます。問題は、クライアント側コード (プロキシ) でメソッドを呼び出したときに XML コメントが表示されないことです。

クライアント側のコードに xml コメントを表示する方法、または .wsdl ファイルからコメントを抽出してクライアント コードに関連付ける方法を知っている人はいますか?

ありがとう！

次に例を示します。

ArgumentNullExceptionの2つの異なる理由。MSDNのString.Formatの例は、の2つの異なる理由を示していFormatExceptionます。それで、それはこのように行われますか？

または他の方法？

XmlDocumentを使用してxmlファイルを解析していますが、XmlDocumentは常にxmlコメントをxmlノードとして読み取っているようです。

私のC＃コード

Xmlファイル

.NETはXMLコメントをスキップするべきではありませんか？

C# で XML コメントを作成して折りたたむと、次のように表示されます。

しかし、VB では潜在的に見ることができます

コード上にその行があると、クラスをデバッグしようとするときに多くの不要なノイズが発生する可能性があります。VB の xml コメント プレビューをオフにする方法はありますか?

私の前の質問に関連しています。インターフェイスを定義する場合は、そのメンバーにコメントします。次に、元のコメントが無効になる理由がない限り、実装クラスの実装にコメントを付けません。

Resharperはこれで問題ありません、Visualstudioはそれが警告であると主張します。

重要なのは、継承されたコメントは、それらを操作するときにインテリセンスを介して表示されることです。これは、私の唯一の本当の関心事です。

これについてどう思いますか？

ありがとう