¿Cómo tener comentarios en IntelliSense para funcionar en Visual Studio?

Question

En Visual Studio y C#, cuando se utiliza una función integrada como ToString(), IntelliSense muestra un cuadro amarillo que explica lo que hace.

¿Cómo puedo tener eso para las funciones y propiedades que escribo?

Answer 1

Para generar un área donde se puede especificar una descripción de la función y de cada parámetro para la función, escriba lo siguiente en la línea antes de que su función y presione Intro :

• C #: ///

• VB: '''

Etiquetas recomendados para la documentación Comentarios (C # Guía de programación) para más información sobre el contenido estructurado puede incluir en estos comentarios.

Answer 2

Lo que se necesita es xml comentarios - básicamente, que siguen esta sintaxis (como se describe vagamente por Solmead):

C #

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

Answer 3

<c>text</c> - El texto que deseas indicar como código.
El <C> etiqueta le brinda una manera de indicar que el texto dentro de una descripción debe marcarse como código.Usar <código> para indicar varias líneas como código.

<code>content</code> - El texto que deseas marcar como código.
El <código> la etiqueta le brinda una manera de indicar varias líneas como código.Usar <C> para indicar que el texto dentro de una descripción debe marcarse como código.

<example>description</example> - Una descripción del código de muestra.
El <ejemplo> la etiqueta le permite especificar un ejemplo de cómo utilizar un método u otro miembro de la biblioteca.Esto comúnmente implica el uso del <código> etiqueta.

<exception cref="member">description</exception> - Una descripción de la excepción.
El <excepción> la etiqueta le permite especificar qué excepciones se pueden lanzar.Esta etiqueta se puede aplicar a definiciones de métodos, propiedades, eventos e indexadores.

<include file='filename' path='tagpath[@name="id"]' />
El <incluir> la etiqueta le permite hacer referencia a comentarios en otro archivo que describen los tipos y miembros en su código fuente.Esta es una alternativa a colocar comentarios de documentación directamente en su archivo de código fuente.Al colocar la documentación en un archivo separado, puede aplicar el control de fuente a la documentación por separado del código fuente.Una persona puede desproteger el archivo de código fuente y otra persona puede desproteger el archivo de documentación.El <incluir> La etiqueta utiliza la sintaxis XML XPath.Consulte la documentación de XPath para conocer formas de personalizar su <incluir> uso.

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

El <encabezado de lista> El bloque se utiliza para definir la fila de encabezado de una tabla o lista de definiciones.Al definir una tabla, sólo necesita proporcionar una entrada para el término en el encabezado.Cada elemento de la lista se especifica con un <artículo> bloquear.Al crear una lista de definiciones, deberá especificar tanto el término como la descripción.Sin embargo, para una tabla, lista con viñetas o lista numerada, solo necesita proporcionar una entrada para la descripción.Una lista o tabla puede tener tantos <artículo> bloques según sea necesario.

<para>content</para>
El <paraca> la etiqueta se utiliza dentro de una etiqueta, como <resumen>, <comentarios>, o <devoluciones>, y le permite agregar estructura al texto.

<param name="name">description</param>
El <parámetro> La etiqueta debe usarse en el comentario de una declaración de método para describir uno de los parámetros del método.Para documentar múltiples parámetros, use múltiples <parámetro> etiquetas.
El texto para el <parámetro> la etiqueta se mostrará en IntelliSense, el Explorador de objetos y en el Informe web de comentarios de código.

<paramref name="name"/>
El <paramrefLa etiqueta > le brinda una manera de indicar que una palabra en el código comenta, por ejemplo en un <resumen> o <comentarios> bloque se refiere a un parámetro.El archivo XML se puede procesar para formatear esta palabra de alguna manera distinta, como con fuente en negrita o cursiva.

<permission cref="member">description</permission>
El <permiso> etiqueta le permite documentar el acceso de un miembro.La clase PermissionSet le permite especificar el acceso a un miembro.

<remarks>description</remarks>
El <comentarios> la etiqueta se utiliza para agregar información sobre un tipo, complementando la información especificada con <resumen>.Esta información se muestra en el Explorador de objetos.

<returns>description</returns>
El <devoluciones> La etiqueta debe usarse en el comentario de una declaración de método para describir el valor de retorno.

<see cref="member"/>
El <ver> etiqueta le permite especificar un enlace dentro del texto.Usar <ver también> para indicar que el texto debe colocarse en una sección Ver también.Utilice el atributo cref para crear hipervínculos internos a páginas de documentación para elementos de código.

<seealso cref="member"/>
El <ver también> etiqueta le permite especificar el texto que quizás desee que aparezca en una sección Ver también.Usar <ver> para especificar un enlace desde dentro del texto.

<summary>description</summary>
El <resumen> la etiqueta debe usarse para describir un tipo o un miembro de tipo.Usar <comentarios> para agregar información complementaria a una descripción de tipo.Utilice el atributo cref para habilitar herramientas de documentación como Sandcastle para crear hipervínculos internos a páginas de documentación para elementos de código.El texto para el <resumen> la etiqueta es la única fuente de información sobre el tipo en IntelliSense y también se muestra en el Explorador de objetos.

<typeparam name="name">description</typeparam>
El <tipoparam> La etiqueta debe usarse en el comentario para una declaración de método o tipo genérico para describir un parámetro de tipo.Agregue una etiqueta para cada parámetro de tipo del tipo o método genérico.El texto para el <tipoparam> La etiqueta se mostrará en IntelliSense, el informe web de comentarios de código del Explorador de objetos.

<typeparamref name="name"/>
Utilice esta etiqueta para permitir a los consumidores del archivo de documentación formatear la palabra de alguna manera distinta, por ejemplo, en cursiva.

<value>property-description</value>
El <valor> etiqueta le permite describir el valor que representa una propiedad.Tenga en cuenta que cuando agrega una propiedad mediante el asistente de código en el entorno de desarrollo de Visual Studio .NET, agregará un <resumen> etiqueta para la nueva propiedad.Luego deberías agregar manualmente un <valor> etiqueta para describir el valor que representa la propiedad.

Answer 4

No comentando XML, como este

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

Answer 5

/// utilizar para comenzar cada línea del comentario y tener el comentario contiene la xml apropiado para el lector de datos de metadatos.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

A pesar de que personalmente, creo que estos comentarios son generalmente equivocada, a menos que usted está desarrollando clases en que el código no puede ser leído por sus consumidores.

Answer 6

Se llaman XML Comentarios . Han sido una parte de Visual Studio desde siempre.

Usted puede hacer su proceso de documentación más fácil mediante el uso de GhostDoc , un complemento gratuito para Visual Studio que genera comentarios XML-doc para usted. Sólo tiene que colocar el cursor sobre el método / propiedad que desea documentar y pulse Ctrl-Shift-D.

Este es un ejemplo de uno de mis mensajes .

Espero que ayude:)

Answer 7

En CSharp, Si crea el contorno método / función con su Parms, a continuación, cuando se agrega el tres barras que se auto generar la sección de resumen y parms.

Así que puse en:

public string myMethod(string sImput1, int iInput2)
{
}

Me pongo a continuación, los tres /// antes y Studio de Visual me dio esto:

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

Answer 8

http://msdn.microsoft.com/en-us/library /3260k4x7.aspx especificando los comentarios no aparecerán los comentarios de ayuda en intelliSense.

Answer 9

Definir métodos como éste y obtendrá la ayuda que necesita.

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

Captura de pantalla del uso de código

Answer 10

También el estudio visual complemento en el doc fantasma intentará crear y rellenar los comentarios de cabecera de su nombre de la función.

Answer 11

Todas estas otras respuestas tienen sentido, pero son incompletos. Visual Studio procesará comentarios XML, pero usted tiene que encenderlos. He aquí cómo hacerlo:

Intellisense utilizará XML comenta que introduzca en su código fuente, pero hay que tenerlos activados a través de opciones de Visual Studio. Ir a Tools> Options> Text Editor. Para Visual Basic, habilitar la configuración Advanced Generate XML documentation comments for '''>. Para C #, permitirá a la> configuración Advanced Generate XML documentation comments for ///. Intellisense utilizará los comentarios de resumen cuando entró. Estarán disponibles a partir de otros proyectos después de que el proyecto de referencia se compila.

Para crear externo documentación, es necesario generar un archivo XML a través de la Project Settings> Build> XML documentation file: camino que controla la opción /doc del compilador. Usted necesitará una herramienta externa que tendrá el archivo XML como entrada y generar la documentación en su elección de formatos de salida.

Tenga en cuenta que la generación del archivo XML puede aumentar notablemente el tiempo de compilación.

Answer 12

Solmead tiene la respuesta correcta. Para más información se puede ver en XML Comentarios .