問題タブ [xml-documentation]

私は常に、C# xml 構文を使用して、クラスとメソッドの適切なコード コメントを書くことを強調してきました。後で簡単にエクスポートできるといつも思っていました。

今日、私は実際にそうしなければなりませんが、方法を見つけるのに苦労しています。足りないものはありますか？Menu->Build->Build Code Documentationに移動したいのですが、それを行うオプションはありません。

.Net でメンバーをインラインで文書化するにはどうすればよいですか? 説明させてください。コメントからドキュメントを抽出するほとんどのツールは、メンバー宣言の後に簡単な説明を追加できるインライン ドキュメントをサポートしています。何かのようなもの：

C# または .NET 言語でこれを行う方法はありますか?

「CompareOrdinalOverloads」などのMSDNリンクが表示されます。どうすればC＃でそのようなリンクを書くことができますか？

私は試した：

しかし、コンパイラーは、他のオーバーロードを持つメソッドのあいまいな参照であることについて警告を出します。

（最初の質問：オーバーロードにリンクするために実際にこのタグを作成する必要がありますか、それともドキュメントプロセッサによって自動的に生成されますか？）

xml ドキュメントを作成するときは<see cref="something">something</see>、もちろん機能する を使用できます。しかし、ジェネリック型を持つクラスまたはメソッドをどのように参照するのでしょうか?

どこかに xml ドキュメントを書くつもりなら、どのようにファンシー クラスを参照すればよいでしょうか? を参照するにはどうすればよいFancyClass<string>ですか? メソッドはどうですか？

たとえば、別のクラスでは、のインスタンスを返すことをユーザーに知らせたいと思いましたFancyClass<int>。そのためのsee crefをどのように作成できますか？

この質問は、この質問 Code documentation how much is too much?から生じています。

答えの 1 つは、xml ドキュメントを別のファイルに保存することでした。コードを調べているときにドキュメントの冗長性が煩わしいのに対し、インテリセンスを介して適切なメソッドを検索したり、ドキュメントを公開したりするときに冗長性が役立つため、その答えが本当に気に入りました。

答えは include タグを使用することでした

include タグに関する MSDN の記事もここにあります。

概要情報を非表示にする方法はわかりましたが、方法のドキュメントをそこに配置する方法もわかりませんでした。(これは、クラスの概要自体よりも重要です。

xml コメントを使用して、コンポーネントのパブリック メンバーと内部メンバーおよびプライベート メンバーを文書化しています。最終製品で Visual Studio Intellisense を "リッチ" (メソッド、例外、パラメーターの説明など) にできるようにするために、生成されたドキュメント xml ファイルをコンポーネント アセンブリと共にパッケージ化したいと考えています。問題は、C# コンパイラがすべてのドキュメント エントリ (内部クラス、メソッド、内部列挙型のプライベート フィールドなどを含む) を作成し、「パブリック メンバーのみ」モードへの切り替えがないように見えることです。

今は、それぞれに XX メソッドを含む 50 個を超えるファイルにアクセスして、プライベート メンバーと内部メンバーのすべてのコメントを削除したくありません。たとえそれを行ったとしても、自動生成されたリソース ファイルではあまり成功しないでしょう。これらの厳密に型指定されたリソース クラスは自動的にコメント化され、公開されないからです。

私の質問は: 私が見落としているオプション/フラグはありますか? いいえの場合、(コードを書き始める前に) パブリック メンバーを残りから分離するのに役立つツールはありますか?

皆さん、

新しい WCF サービスを作成していて、サービス インターフェイスから始めました。次のようになります。

ここで、SomethingRequest および SomethingResponse メッセージを記述した別のファイルにデータ コントラクトもいくつか作成しました。

プロジェクトをコンパイルし、svcutil.exe を起動して DLL からメタデータ (WSDL および XSD) を抽出しましたが、すべてのコメントと説明を WSDL/XSD に取得して / に入れる方法があるかどうかわかりません。ノード。

さらに別のあいまいな svcutil.exe パラメーターがわかりませんか、それともメタデータでこのドキュメントを自動的に生成する方法は本当にありませんか??

編集: わかりました、Marc Gravell の回答に基づいて、コメントとドキュメント文字列はコンパイルされた DLL にも、MEX メタデータ交換プロトコル (残念!) 経由でも利用できません。

SO THEN: サービスにアクセスするために必要な情報をサードパーティに提供する必要がある場合、WCF サービスをどのように文書化しますか?? 私のWCFサービスライブラリをスキャンし、アノテーションを含むソースコードからWSDLとXSDを構築する「NService」または「WCF用サンドキャッスル」ツールはありますか??

これを行うためのツールや方法がたくさんあるようには見えません - 正直なところ、私の大きな驚きに....

マルク

1. XML ドキュメント ファイルに付属する外部アセンブリを使用する場合、Visual Studio でそれを見つけるにはどうすればよいですか?

2. XML ドキュメント ファイルを持っている場合、プログラムや xml 変換ファイル、またはそれを適切に表示するために使用できるものはありますか? msdn ドキュメント ビューアーほど複雑である必要はありませんが、少なくとも純粋な xml よりは優れています...

述語ヘルパー クラスの XML ドキュメントを作成します。Expression<Func<T, bool>>しかし、構文エラーなしで参照できることがわかりません。それは可能ですか？私はこれを試しました：

しかし、下に赤い波線が表示され{T, bool}}ます。これはうまくいきます：

誰にも手がかりがありますか？

アップデート：

与えられた（そして私が受け入れた）答えは一見うまくいったようです。しかし今、私は解決できないものについて多くの警告を受け始めました. 私は多くのことを扱うというクラスを持っていExpressionBuilder<T>ますExpression<Func<T, bool>>。もちろん、XML コメントでそれを参照したいと思います。

私が知っている両方のバージョンを試しました：

しかし、どちらも機能しません。(そして最後のものでは、ReSharper は青い波線を下{T,Boolean}}に置きます。使用したすべての場所でコンパイル中に 2 つの警告が表示されます。

1. 「何とか」の XML コメントには、解決できなかった cref 属性「Expression>」があります。
2. 型パラメーターの宣言は、型ではなく識別子でなければなりません。エラー CS0081 も参照してください。

私が参照しようとした場所で同じ問題を抱えていますRange<Nullable<DateTime>>（Range<DateTime?>どちらも機能しませんでした。 { } と の両方で< >）

これらの種類のジェネリックを参照することは想定されていませんか?