2010-07-25 7 views
24

Cuando trabajas en Visual Studio 2010 y escribes un comentario sobre un método y haces clic en entrar Visual Studio 2010 te permite crear comentarios XML "ver" y "ver también".¿Cuál es el significado de las etiquetas XML "see" y "seealso" en C# en Visual Studio 2010?

Si escribe en el comentario "ver" y presione la tecla TAB entonces parece que

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

¿Cuál es el significado de la misma en C#?

+2

Eso no es realmente C#, sino parte del estándar de documentación predeterminado de .Net. – Dykam

+0

Las tres barras diagonales inversas son sintaxis C#. –

+0

@Philip: No, solo los primeros 2 son C#. Simplemente colorear la sintaxis VS que hace que se vea diferente. –

Respuesta

26

Ambas son etiquetas de documentación XML verificadas por el compilador.

<see> es para colocar enlaces directamente en el texto.

<seealso> es colocar texto en la sección "Ver también".

Vea cómo se usan en this ejemplo.

+0

Todavía extrañamos un ejemplo significativo de la diferencia. El ejemplo presentado a través del enlace solo muestra que '' produce un elemento xml mientras '' otro. – LosManos

1

Esos elementos se utilizan para la creación de documentación. Si observa MSDN, encontrará varios enlaces en las descripciones de clase que hacen referencia a otros tipos.

Editar Ver http://www.sandcastledocs.com/ como una aplicación de ejemplo para crear esos archivos de ayuda.

2

Ver y Ver También se convierten en referencias a otras clases en la documentación generada, según el estándar de documentación .NET xml.

Lea http://msdn.microsoft.com/en-us/library/5ast78ax.aspx para obtener más información sobre las etiquetas disponibles.

Tenga en cuenta que, además de eso, Sandcaslte también es compatible con las subclases, copiando en la documentación de la clase base.

+0

no, es TFTM stand for Toll Free Telephone Meetings –

Cuestiones relacionadas