2010-07-25 5 views
24

Lorsque vous travaillez dans Visual Studio 2010 et écrivez un commentaire sur une méthode et que vous cliquez sur Entrée Visual Studio 2010 vous permet de créer des commentaires XML "Voir" et "Voir aussi".Quelle est la signification des balises XML "see" et "seealso" en C# dans Visual Studio 2010?

Si vous tapez dans le commentaire « voir » et appuyez sur TAB il ressemble

/// <see cref=""/> 
/// <seealso cref=""/> 

Quel est le sens de celui-ci en C#?

+2

Ce n'est pas vraiment C# mais une partie de la norme de documentation .Net par défaut. – Dykam

+0

Les trois barres obliques inverses sont une syntaxe C#. –

+0

@Philip: Non, seuls les 2 premiers sont en C#. Juste coloration de la syntaxe VS qui lui donne un aspect différent. –

Répondre

26

Les deux sont des balises de documentation XML vérifiées par le compilateur.

<see> est de placer des liens directement dans le texte.

<seealso> est de placer du texte dans la section "Voir aussi".

Voir comment ils sont utilisés dans l'exemple this.

+0

Nous manquons toujours un exemple significatif de ce que la différence. L'exemple présenté via le lien montre simplement que '' produit un élément XML tandis que '' un autre. – LosManos

1

Ces éléments sont utilisés pour la création de documentation. Si vous regardez MSDN, vous trouverez plusieurs liens dans les descriptions de classe qui se réfèrent à d'autres types.

Modifier Voir http://www.sandcastledocs.com/ comme exemple d'application pour créer ces fichiers d'aide.

2

Voir et VoirAussi se transforment en références à d'autres classes dans la documentation générée, conformément à la norme de documentation xml .NET.

Veuillez lire http://msdn.microsoft.com/en-us/library/5ast78ax.aspx pour plus d'informations sur les étiquettes disponibles.

Notez que, en plus de cela, Sandcaslte prend également en charge sur les sous-classes, en copiant dans la documentation de la classe de base.

+0

non c'est TFTM stand pour les réunions téléphoniques sans frais –

Questions connexes