5

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

IDictionary（TKey、TValue） —この例では、備考セクションに移動すると、私が話していることがわかります。

Sandcastle HelpFileBuilderを使用しています。

4

3 に答える 3

6

実際、SandcastleとSandcastle Help File Builderはどちらも<note>要素をサポートしていますが、非常によく隠されています。:-)それは私が知っている2つの場所でのみ文書化されています：

  1. DyncityからのXMLドキュメントコメントガイドのリファレンス...これは明らかにWebでは利用できなくなりました。リンクは以前はhttp://www.dynicity.com/downloads/default.aspxでした。
  2. Simple-Talk.comの「TamingSandcastle： A .NET Programmer's Guide toDocumentingYourCode」というタイトルの私の記事に付随するウォールチャート。ウォールチャートにアクセスするためのリンクが記事にあることに注意してください。ただし、記事の一番下にあるので、ここで両方のリンクを示しました。（私の記事にもDyncityのガイドへの参照があります。編集スタッフと連絡を取り、現在孤立しているDyncityガイドのローカルコピーをホストするかどうかを確認し、ホストする場合はここに更新を投稿します。）

これは、要素に関するすべてのドキュメントについてです<note>。（これは私のウォールチャートからのものです。Dyncityガイドは本質的に同じことを言っていますが、それほど簡潔ではありません。）

ノート要素の構文

その不十分なドキュメントは、残念ながら私が見つけたすべてです<note>。そこで、簡単な試用を実行し、各メモの種類を[備考]セクションに埋め込みました。これがそれが生み出したものです：

サンドキャッスルノート出力のサンプル

つまりtype="caution"、私の特定の例では、他の2つのタイプ属性値が同じメモアイコンとラベルを生成している間に、注意アイコンとラベルが表示されます。下草に深く埋もれている他の用途もあるのではないかと思います。

于 2011-09-13T19:09:14.203 に答える
2

ボビーの答えに対するcubrrのコメントを拡張するために、実際には、サンドキャッスルのNote要素に関するかなり広範なドキュメントがあります。

remark要素やsummary要素など、他のデフォルトの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>

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

于 2016-01-02T20:24:14.980 に答える
1

Sandcastleに関するドキュメントはほとんどありませんが、メモの出力はSandcastleからのものであり、C＃のネイティブXMLコメントタグからのものではない可能性があります。

メモセクションを配置して、Sandcastleの出力を確認する場合は、次のコードを使用してみてください（これは以前はサポートされていましたが、変更されたかどうかはわかりません）。

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

詳細については、Microsoft Assistance MarkupLanguageLonghornヘルプを参照してください。

于 2011-09-13T12:44:36.327 に答える