Commentaires XML - Documentation MSDN “Note” de la section — comment dupliquer ce?

Question

Pour l'essentiel, dans l'aide en ligne MSDN j'ai souvent courir dans une "NOTE" de la section, mais pas pour la vie de me comprendre comment obtenir la même sortie.Il n'est apparemment pas <note> la balise.Personne ne sait comment le faire fonctionner?

IDictionary(TKey, TValue) — Dans cet exemple, si vous vous rendez dans la section des remarques, vous verrez de quoi je parle.

Je suis l'aide de Sandcastle Help File Builder.

Answer 1

En fait, les deux Châteaux de sable et de Châteaux de sable Fichier d'Aide du Générateur de soutenir une <note> ces éléments, même s'il est très bien caché!:-) C'est documentée dans les deux endroits que je connais:

1. L' Les Commentaires de Documentation XML Guide référence de Dyncity...ce qui est apparemment plus disponible sur le web: le lien utilisé pour être http://www.dynicity.com/downloads/default.aspx.
2. Un affiche murale accompagner mon article sur Simple-Talk.com droit Apprivoiser Le Château De Sable:Un .NET Guide du Programmeur à la Documentation de Votre Code.Notez qu'il y a un lien dans l'article pour accéder à l'affiche murale, mais il est tout en bas de l'article, j'ai donné des liens pour les deux ici.(J'ai une référence à Dyncity guide dans mon article;Je vais communiquer avec le personnel de la rédaction afin de voir s'ils veulent accueillir une copie locale de la désormais orphelins de la Dyncity guide et publier une mise à jour ici si ils le font.)

Voici à ce sujet l'ensemble de la documentation, il est pour le <note> de l'élément.(Ce qui est de ma planche murale;le Dyncity guide dit essentiellement la même chose, mais avec beaucoup moins de façon concise.)

Que l'insuffisance de la documentation est malheureusement tout ce que j'ai trouvé sur <note>.Alors j'ai couru un rapide essai, l'intégration de chaque type de note à l'intérieur d'un Remarques de la section.Voici ce qu'il produit:

---

C'est, avec type="caution" vous obtenez l'icône d'avertissement et de l'étiquette, tandis que les deux autres type de valeurs d'attribut de produit la même note icône et l'étiquette dans mon exemple particulier.Je pense qu'il y peut-être d'autres facettes de son utilisation enfouis dans le sous-bois.

Answer 2

Pour développer sur cubrr commentaire de Bobby réponse est en fait maintenant quelques raisonnablement vaste documentation sur l'élément de Note dans le château de sable.

Il existe quatre catégories de noter que vous pouvez ajouter à tout autre défaut de l'élément xml comme le remarque ou un résumé des éléments.Ce sont en Général, les mises en garde, de la Sécurité ou de la Langue.La principale différence entre eux semble être le type d'icône ils donnent la note et le titre que la note a côté de l'icône.Vous pouvez voir la liste complète de tous ces types de note ici.

Le code suivant généré le ci-dessous le résultat pour moi:

/// <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>

Résultat:Généré Fichier D'Aide

Answer 3

Il y a très peu de documentation sur le château de sable, mais la remarque de sortie est potentiellement de château de sable et pas de C#native XML, les balises de commentaire.

Vous pouvez essayer d'utiliser le code suivant où vous voulez mettre une note de la section et voir ce que les Châteaux de sable de sorties (ce utilisé pour être pris en charge ne sais pas si ça a changé):

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

Voir: Microsoft Aide De Langage De Balisage Longhorn Aider pour plus d'informations.