Generar automáticamente documentación de funciones en Visual Studio

Question

Me preguntaba si hay una manera (ojalá sea un atajo de teclado) para crear encabezados de función de generación automática en Visual Studio.

Ejemplo:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Y se convertiría automáticamente en algo así ...

'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

Answer 1

Haga que " tres marcadores de comentarios únicos "

En C # es ///

que por defecto se escupe:

/// <summary>
/// 
/// </summary>
/// <returns></returns>

Aquí hay algunos consejos para editar plantillas VS .

Answer 2

GhostDoc !

Haga clic derecho en la función, seleccione " Documente esto " y

private bool FindTheFoo(int numberOfFoos)

se convierte

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(sí, todo es autogenerado).

Tiene soporte para C #, VB.NET y C / C ++. Está asignado por defecto a Ctrl + Shift + D .

Recuerde: debe agregar información más allá de la firma del método a la documentación. No se detenga solo con la documentación autogenerada. El valor de una herramienta como esta es que genera automáticamente la documentación que se puede extraer de la firma del método, por lo que cualquier información que agregue debe ser nueva información.

Dicho esto, personalmente prefiero cuando los métodos son totalmente autodocumentados, pero a veces tendrás estándares de codificación que exigen documentación externa, y luego una herramienta como esta te ahorrará mucho tipeo.

Answer 3

///

es el acceso directo para obtener el bloque de comentario Descripción del método. Pero asegúrese de haber escrito el nombre y la firma de la función antes de agregarlo. Primero escriba el nombre y la firma de la función.

Luego, encima del nombre de la función, simplemente escriba ///

y lo obtendrá automáticamente

Answer 4

Visual Assist tiene una buena solución también, y es altamente costumizable.

Después de ajustarlo para generar comentarios de estilo doxygen, estos dos clics producirían -

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

(En la configuración predeterminada, es un poco diferente)

---

Editar: La forma de personalizar el texto del 'método de documento' está en VassistX- > Visual Assist Options- > Sugerencias, seleccione 'Editar fragmentos de VA', Idioma: C ++, Tipo: Refactorización, luego vaya a 'Método de documento' y personalice. El ejemplo anterior es generado por:

Answer 5

Normalmente, Visual Studio lo crea automáticamente si agrega tres marcadores de comentarios por encima de lo que desea comentar (método, clase).

En C # esto sería /// .

Si Visual Studio no hace esto, puede habilitarlo en

  

Opciones- > Editor de texto- > C # - > Avanzado

y verifique

  

Generar comentarios de documentación XML para ///

Answer 6

En Visual Basic, si crea su función / sub primero, luego en la línea que está arriba, escribe 'tres veces, generará automáticamente el xml relevante para la documentación. Esto también aparece cuando pasa el mouse en intellisense y cuando hace uso de la función.

Answer 7

Puede usar fragmentos de código para insertar las líneas que desee.

Además, si escribe tres comillas simples ('' ') en la línea sobre el encabezado de la función, insertará la plantilla de encabezado XML que luego puede completar.

Estos comentarios XML pueden ser interpretados por el software de documentación, y se incluyen en la salida de compilación como un archivo assemble.xml. Si mantiene ese archivo XML con la DLL y hace referencia a esa DLL en otro proyecto, esos comentarios estarán disponibles en intellisense.

Answer 8

Estoy trabajando en un proyecto de código abierto llamado Todoc que analiza palabras para producir automáticamente la salida de documentación adecuada al guardar un archivo. Respeta los comentarios existentes y es realmente rápido y fluido.

http://todoc.codeplex.com/