XMLコメント-MSDNドキュメント「メモ」セクション - これをどのように複製しますか？

Question

基本的に、MSDNオンラインヘルプでは、「メモ」セクションに遭遇することがよくありますが、同じ出力を取得する方法を理解することはできません。どうやらはありません <note> 鬼ごっこ。誰かがこれを機能させる方法を知っていますか？

Idictionary（tkey、tvalue） - この例では、備考セクションに行くと、私が話していることがわかります。

サンドキャッスルヘルプファイルビルダーを使用しています。

Answer 1

実際、サンドキャッスルとサンドキャッスルの両方がファイルビルダーのサポート <note> 要素、それは非常によく隠されていますが！ :-)それは私が知っている2つの場所でのみ文書化されています：

1. XMLドキュメントコメントガイド Dyncityからの参照...これは明らかにWebで利用できなくなったようです - 以前はリンクが http://www.dynicity.com/downloads/default.aspx.
2. a WallChart Simple-talk.comの記事に添付されています サンドキャッスルのタミング：コードを文書化するための.NETプログラマーズガイド. 。記事にはウォールチャートに到達するリンクがありますが、記事の一番下にあるため、両方にリンクを提供しました。 （私の記事にもDyncityのガイドへの言及があります。編集スタッフと連絡を取り、現在乱れたDyncityガイドのローカルコピーをホストしたいかどうかを確認し、ここに更新を投稿します。）

ここにあるすべてのドキュメントがあります <note> エレメント。 （これは私のWallChartからのものです。DyncityGuideは本質的に同じことを言っていますが、それほど簡潔ではありません。）

その不十分なドキュメントは、私が見つけたものすべてです <note>. 。だから私はクイックトライアルを実行し、各メモタイプを埋め込みました 備考 セクション。これがそれが生み出したものです：

---

つまり、 type="caution" 私の特定の例では、他の2つのタイプの属性値が同じメモアイコンとラベルを作成し、注意アイコンとラベルを取得します。私は、その使用の他の側面が下部に深く埋もれているかもしれないと思う。

Answer 2

Bobbyの答えに関するCubrrのコメントを拡大するために、実際にはSandcastleのNote要素に関するかなり広範な文書があります。

注目や概要要素など、他のデフォルトのXML要素に追加できる4つのカテゴリのメモがあります。これらは、一般的、注意、セキュリティ、または言語です。それらの主な違いは、メモを与えるアイコンのタイプと、メモがアイコンの隣にあるタイトルであるようです。これらすべてのメモタイプの完全なリストを見ることができます ここ.

以下のコードは、私にとって以下の結果を生成しました。

/// <remarks>
/// <note type="note">
/// This is a note in a remark. It is a General note.
/// </note>
/// <note type="tip">
/// This is a tip note in a remark. It is a General note.
/// </note>
/// <note type="implement">
/// This is a implement note in a remark. It is a General note.
/// </note>
/// <note type="caller">
/// This is a caller note in a remark. It is a General note.
/// </note>
/// <note type="inherit">
/// This is a inherit note in a remark. It is a General note.
/// </note>
/// <note type="caution">
/// This is a caution note in a remark. It is a Cautionary note.
/// </note>
/// <note type="important">
/// This is a important note in a remark. It is a Cautionary note.
/// </note>
/// <note type="security">
/// This is a security note in a remark. It is a Security note.
/// </note>
/// <note type="cs">
/// This is a cs note in a remark. It is a Language note.
/// </note>
/// </remarks>

結果：生成されたヘルプファイル

Answer 3

サンドキャッスルに関するドキュメントはほとんどありませんが、メモ出力は潜在的にサンドキャッスルからのものであり、C＃のネイティブXMLコメントタグではありません。

次のコードを使用して、メモセクションを配置し、サンドキャッスルの出力を確認することを試みることができます（これは、変更されたかどうかわからない場合はサポートされていました）：

<alert class="note">This is a 'alert class=note'</alert>

見る： マイクロソフト支援マークアップ言語ロングホーンヘルプ 詳細については。