問題タブ [xml-comments]

C＃のXMLドキュメントコメントで、2つ以上の関数を相互にオーバーロードするようにマークして、相互に自動的に参照する方法はありますか？理想的には、それらはサンドキャッスルで生成されたドキュメントにも何らかの形でグループ化されます。

目的：多くの場合、このグループの関数にリンクしたいと思います。たとえば、ユーティリティ関数のリストで、オーバーロードの1つに言及し、そこから他の関数​​を簡単に見つけられるようにします。

現在、リンクを追加していますが、面倒です。

Visual Studioで自動コメント機能のトリガーを入力すると（「'''」または「///」と入力して）、ほとんどのXMLコメントの詳細が表示されます。ただし、私は通常、履歴タグをドキュメントに追加して、時間の経過とともにメソッドに加えられた変更を追跡および変更できるようにします。

自動コメント機能をカスタマイズして、履歴タグを追加し、場合によっては一般的な名前-日付-プレースホルダーテキストを変更する方法はありますか？

私の同僚は、ソフトウェアで作業するときにXMLコメントを使用することはめったにありません（私がこれ以上優れているとは言えません）。私は最近それらを使用することの利点を見てきましたが、それらが文書化するコードが明確に書かれている場合（表現的/説明的な変数/関数名、いくつかのインラインコメント）、それらは本当に価値がありますか？

ありがとう！

プロジェクトのプロパティ ページの [構成プロパティ] フォルダーの下に [ビルド] オプションが見つからないようです。私はそれを行う方法を理解しようとしていたるところを見てきました。

ここで指示に従いました：http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

具体的には、http: //msdn.microsoft.com/en-us/library/azt1z1eh.aspx (「Visual Studio 内で XML ドキュメント サンプルをビルドするには」セクション) を参照してください。

ビルドで自分のプロジェクトの XML コメントを生成したいのですが、「構成プロパティ」ウィンドウの下に「フォルダー」または「ビルド」オプションがありません。

Visual Studio Team System 2008 を使用していますが、アイデアはありますか?

編集 -> これは [プロジェクトのない] ウェブサイトで、C# と VB.NET の両方で書かれています。

ツールをダウンロードする必要はありますか? GhostDoc を見つけましたが、あまり役に立ちません。

C＃では、<see cref = "blah" />を使用して、paramsキーワードを含むメソッドシグネチャを参照しようとしています。これがパラメータリストを配列に変換することは知っていますが、CREF属性で配列を参照する方法さえ理解できません。私は自分の検索で何も見つけていませんし、私が知っている人も誰も考えを持っていません。コンパイラは角かっこで窒息しています。中括弧を使用し、Arrayクラスを使用して、あらゆる種類の異なる組み合わせを試しましたが、何も機能していません。誰かがこれを知っていますか？

XMLコメントを使用して、クラスライブラリのすべてのタイプ、メソッド、プロパティなどを完全に文書化しようとしましたが、cref属性（seeたとえば、タグで使用される）に関連する奇妙な効果に遭遇しました。このMSDNページのアドバイスに加えて、MSDNや他のWebサイトの他のさまざまな例に従うと、crefタグを使用して参照値を指定するときは常に、参照を分類する特定のマーカー（'など）をプレフィックスとして付ける必要があるようです。タイプの場合はT：'、メソッドの場合は' M：'）。

ただし、Microsoft Sandcastleを使用すると、これらのプレフィックスを見逃すことにより、生成されたドキュメント（この場合はCHMヘルプファイル）に影響があることがわかりました。プレフィックスを含めると（私が信じるすべての状況で）、参照は太字のテキストとしてページにレンダリングされます...ただし、プレフィックスを除外すると、参照はAPIリファレンス内の適切なページへのアンカー（リンク）としてレンダリングされます。（すべて？）参照に接頭辞を付ける推奨される方法が最も役に立たない結果をもたらすことは私にはかなり奇妙に思えます-ある場合には参照を太字でレンダリングし、別の場合にはリンクする必要があるのはなぜですか？誰かがこれに光を当てることができれば幸いです。

警告をエラーとしてオンにしたので、すべてのパブリック メソッドに XML コメントを付ける必要があります。

プログラムをコンパイルするためだけに、とりあえずプレースホルダーを置きたいだけです。

クラスまたはファイル内のすべてのパブリック メンバーに XML コメントを自動的に追加する方法はありますか。

自動生成された優れた XML コメントを提供するゴースト doc を確認しましたが、一度に 1 つのメンバーしか実行していないように見えます。

コメントで動的ジェネリック クラス名を参照し、IDE で条件付きで解決できるかどうか疑問に思っていました。

簡単な基本クラスの例:

このクラスから継承し、たまたまUserクラスになった場合、IntelliSense にコメントを「データベースからすべての User メンバーを取得します」として表示させたいと思います。

これは可能ですか？