問題タブ [xml-documentation]

Sandcastle2.4.10520とSandcastleHelpFile Builder 1.8.0を使用して、.chmヘルプファイルを生成しています。

私のドキュメントでは、<see>タグを使用しています。

列挙型を参照しようとすると、<see cref="NumberStyles"/>完全に機能します。

<see cref="NumberStyles.AllowTrailingWhite"/>ドキュメントファイルにリンクが含まれているように列挙値を参照しようとすると、リンクが見つからないMSDNページに移動します

警告は表示されません-私のxmlドキュメントは正しいです。

列挙値を参照するMSDNページにも、ページが見つかりませんというリンクがあることに気付きました。例：UInt64.Parseメソッド（String、NumberStyles、IFormatProvider）が参照しNumberStyles.AllowHexSpecifierているため、別のMSDNページが見つかりません。

列挙値の代わりに列挙を参照する必要がありますか？

列挙型を参照するにはどうすればよいですか？それも可能ですか？

Visual Studioから直接コードのドキュメントから読み取り可能なドキュメントファイルを生成する方法はありますか？（2010年も考慮）

コード例：

私: 私は .NET プラットフォームに比較的慣れていません。

問題

Java では、package-info.java または package.html ファイルを作成してパッケージ フォルダーに保存することにより、パッケージ レベルのドキュメントをプロジェクトに追加できます。Visual Studio 2010 を使用して C# のプロジェクトに同等のドキュメントを追加するにはどうすればよいですか?

バックグラウンド

私が取り組んでいるソース コード プロジェクトのパッケージ/フォルダー レベルのコンテキストで、私の動機を説明するドキュメントを書くのが好きです。私はさまざまな言語 (特に Java) でのこのワークフローに非常に慣れており、自分のプロジェクトを文書化する良い方法だと信じています。

メソッドを調べて、スローされる可能性のある例外についてXMLコメントを追加するツール、できればVS2008/2010にプラグインするツールが必要です。<summary>自分で入力するので、または他のXMLタグを生成したくありませんが、 private/protectedメソッドでも、どの例外がスローされるかを確認できれば便利です。それ以外の場合は、メソッドを調べて、メソッド内のすべてのメソッド呼び出しにカーソルを合わせて例外のリストを表示し、そのメソッドの<exceptionリストを更新して例外のリストを含めます。多分VSマクロはこれを行うことができますか？

これから：

これに：

更新： ツールはメソッドを再帰的に実行する必要があるようです。たとえば、method1は、throwingとして文書化されているmethod3を呼び出すmethod2を呼び出すNullReferenceExceptionため、method2とmethod1の両方がツールによってthrowingとして文書化されますNullReferenceException。また、ツールは重複を排除する必要があります。たとえば、メソッド内の2つの呼び出しがスローとして文書化されている場合DirectoryNotFoundException、メソッドは1回だけリスト<exception cref="System.IO.DirectoryNotFoundException"/>されます。

コンソールなどのクラスを入力したら、Ctrl + スペースを押して IntelliSense を押してヒントを表示します。グーグルで見つけられません。私は愚かな初心者かもしれません。ありがとう。

このツールで抽出できるドキュメント コメント (C# ドキュメント コメントに対応) を VB.NET コードに埋め込むことができるツールの名前は?

古いコードを使用しています。Visual Studio 2005 時代。些細な例は次のとおりです。

Visual Studio のメニューに統合されたサード パーティ製の無料 (オープン ソース?) ドキュメント ジェネレーター ツールがありました。

Microsoft の XML ドキュメント タグに関する SO に関するさまざまな質問をここで見てきましたが、いくつかのサンプル コードを追加するのに問題があります。

これは私に与えます：

<DOxygen の出力とは対照的に、ソースを直接読んでいる場合 (たとえば)、これを使用する以外に、例を理解するのがはるかに難しくなる以外に、これを回避する方法はありますか? ..または、<ここでの唯一のオプションはコードですか?

[編集]提案された CDATA ブロックを試しましたが、単一行でしか機能しないようです:

..しかし、実際に読みやすい例になる可能性のある複数行のコメントではありません。

[Edit2]予想通り失敗した最後の 2 つのステートメントの前から \\ を削除するという pierrre の提案を試みました。

与えます：

インターフェイスとそれを実装するクラスがあり、それに対するxmlコメントをVSインテリセンスまたはドキュメントで使用する場合は、xmlコメントをどこに配置しますか？インターフェイスのメソッドまたは具体的なクラスメソッドに？正しい方法は何ですか？

インターフェイスを使用して変数を宣言しているので、インターフェイスに配置することを考えています。また、具象クラスにもコメントを付けて、同じメソッドで異なるドキュメントが作成される可能性があることを確認すると、冗長になると思います。

何かアイデア、アドバイスはありますか？

以下に示す XML インテリセンス ヘルプ ファイルを生成するには、どのツールが必要ですか?

Visual Studio に古いプロジェクトと同じ API をいくつか含む新しいプロジェクトがあり、xml ドキュメントを新しいプロジェクトにコピーしたいとします。手動で 1 つずつコピー アンド ペーストせずにこれを行う方法はありますか?