問題タブ [xml-comments]

さて、タイトルはそれをすべて尋ねます。

Sandcastle Help File Builder GUI を持っています。ヘルプ ファイルを生成することはできますが、ヘルプ ファイル全体を再コンパイルする以外に、結果をより速く表示する方法があるかどうか疑問に思っていました。

Sandcastle について尋ねたのは、私が試したプレビュー機能を提供する他のツールが、Sandcastle のようにヘルプ ファイルを正確な仕様にコンパイルしないためです。それらのほとんどは、完全に修飾された参照を必要としますが、これはお尻の痛みです。

名前が示すように、辞書インデクサーを参照する方法がわかりません。ここで何か助けはありますか？:)

参考までに、私は試しました：

次の機能がある場合：

seealsoコンストラクトでどのように参照できますか?

「属性値に文字「<」は使用できません」と文句を言います。'<' と '>' を '{' と '}' に変更すると機能しますが、ジェネリック パラメーターが開きます。

3 つの異なるプロジェクトを含む Visual Studio C# ソリューションがあります。各プロジェクトで、xml-comments を使用してすべてのコードにコメントを付けました。コメントを xml に組み込むには、プロジェクトごとに出力ファイルを指定する必要があります。すべての xml コメントを 1 つのファイルに組み込むことは可能ですか?

コードのドキュメントを作成しようとしていますが、xml-commentsを使用しています。クラスが次のように文書化されている場合：

xmlファイルには、mainWindowの次のエントリが含まれます。

T：CaseManager.mainWindowのTは、「タイプ：クラス、インターフェイス、構造体、列挙型、デリゲート」であることを示し、残りはタイプの名前空間と名前を示します。とにかくタイプを指定させる方法はありますか？たとえば、クラスの場合はT：C：...、インターフェイスの場合はT：I：...などと記述します。

次のようなメソッドを作成しました。

しかし、このメソッドを使用すると、Visual Studio (私は VS 2010 を使用しています) は " A method having xml-comments This comment could be... " という完全なドキュメントではありません。

表示するオプションはありますか？

更新された画像:

ありがとう ：-）

VB.Net の XML コメントに改行を入れようとしています。C# に関する他の 2 つの投稿を読みました。

C# の XML 複数行コメント - 何が間違っているのでしょうか?

Intellisense のコメントに改行を追加する

しかし、提案<para>または<br/>タグは機能しません。これ、

まだ次のように表示されます。

どうすればこれを機能させることができますか？

コードから <include> キーワードを使用して、外部コメント ファイル内のメンバーを参照する方法を知っています。何かのようなもの：

ただし、Comments.xml ファイル内にメンバーがあり、これらのメンバーを分割して、Comments.xml ファイル自体の中で参照したいと考えています。例として、複数回使用される引数定義である可能性があります。

上記と同じフォーマットを試しましたが、うまくいきません。何か案は？

ETA: このブログ投稿「Reason 3」によると、まったく同じ構文で動作するはずですが、なぜ動作しないのかわかりません。Visual Studio が生成する xml ファイルを見ると、エラーは発生していません。実際、元の「include」行がまだそこにあるため、メンバーを含めようとしたようには見えません（ただし、「ファイル」部分の前に「パス」部分が表示されます）。

ETA2: 前述のブログ投稿の c# の例を修正して、include-includes を別の xml ファイルに分割する必要がありました。そうしないと、コンパイル時にストック オーバーフローが生成されました。
しかし、私はそれを私のために働かせることはできません。私は VB を使用しており、2008 年と 2010 年にテストしました。どちらも高速版です。これは、構文が異なるか、Visual Studio の VB バージョンに機能が実装されていないことを意味します。

概要タグのコメントを指定する場合、<param>タグを使用してパラメータがオプションであることを示す方法はありますか? クライアントは、次のような値または null を指定できます。<param name="Mime" optional="true">.

グーグルは、属性または許可された値のセットリストを提供できませんでした.

ありがとう

ETA: Visual Studio 2010 VB Express エディションでも同じ動作が見られます。
ETA: Visual Studio 2010 C# Express エディションは同じ動作を示しません。

VisualStudio 2008 VB Express エディションでは、次のコメントを指定します。

ファイルをコンパイルして .xml を調べると、指定した順序とは逆の順序でコメントが含まれていることがわかります。Part3 は Part2 の前に表示され、Part1 の前に表示されます。

なぜこれが起こっているのか誰にも分かりますか？

到着予定時刻:

追加の動作: インライン コメントが外部インクルードの間に散在している場合、それらはすべて最初に xml に書き込まれ、次にインクルードに (逆の順序で) 書き込まれます。

「非直感的な xml コメント動作をオフにする」というオプションを用意してください。