¿Cómo agregar una descripción a las funciones y los parámetros de la función?

Question

Estoy escribiendo una función VB.NET con un montón de sobrecargas. He visto que la mayoría de las funciones .NET tienen descripciones de parámetros en IntelliSense. Por ejemplo, al escribir en String.Compare(, IntelliSense dice Compares two specified System.String objects and returns..., se entiende la idea. Esta descripción cambia y hace clic en diferentes versiones sobrecargadas de las mismas funciones. Cuando comienza a escribir algo para un parámetro, también describe el parámetro que está ingresando actualmente. Ejemplo: strA: The first string to compare..

¿Cómo puedo dar tales descripciones a mis funciones?

Answer 1

Todo lo que tiene que hacer es presionar tres apóstrofes en la línea antes de su función. .NET agregará el resto del código por ti. Inserte el texto que desea mostrar en el intellisense en la etiqueta.

''' <summary> 
''' Returns the name of the code. 
''' </summary> 
Function GetName() As String 
    Return "Something" 
End Function 

Answer 2

Coloque el cursor en la línea antes de que el método y el tipo tres apóstrofos ('''). Obtendrá una plantilla para escribir documentación XML para el método y sus parámetros.

Answer 3

Use xml comentarios. Hay algunas etiquetas predefinidas que se cargan en intellisense después de compilar. y lo maravilloso es que, si coloca el cursor en la línea sobre su función, luego presiona '' '(comillas triples, si tiene sentido) y lo ingresa, se prellenarán un montón de cosas para usted. Heres un artículo:

Documenting Your Code with XML Comments

Answer 4

Haga clic derecho en un nombre de método/miembro y seleccione 'Insertar comentario' en el menú contextual.

El contenido del XML para el miembro/método se mostrará en algunas versiones de Visual Studio, dentro de las ventanas de sugerencias intellisense.

''' <summary> 
    ''' Summary for the method goes here 
    ''' </summary> 
    ''' <param name="value">Param comments go here</param> 
    ''' <remarks></remarks> 
Private Sub SomeMethod(ByVal value As Decimal) 

Answer 5

Para los parámetros ...

''' <summary> 
''' Procedure description 
''' </summary> 
''' <param name="someVariable">someVariable description.</param> 
''' <param name="someVariable">someVariable description.</param> 
''' <remarks></remarks>