function - documentar - generar documentacion visual studio 2015
Auto generar documentación de funciones en Visual Studio (8)
Me preguntaba si hay una forma (con suerte atajo de teclado) para crear encabezados de funciones de generación automática en Visual Studio.
Ejemplo:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
Y automágicamente se convertiría en algo como esto ...
''----------------------------------
''Pre:
''Post:
''Author:
''Date:
''Param1 (String):
''Param2 (Integer):
''Summary:
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)
En Visual Basic, si primero crea su función / sub, en la línea superior, escriba ''tres veces, generará automáticamente el xml correspondiente para la documentación. Esto también aparece cuando pasas el ratón por intellisense y cuando haces uso de la función.
Estoy trabajando en un proyecto de código abierto llamado Todoc que analiza las 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.
Haz que "tres marcadores de comentarios únicos"
En C # es ///
que por defecto escupe:
/// <summary>
///
/// </summary>
/// <returns></returns>
Normalmente, Visual Studio lo crea automáticamente si agrega tres marcadores de comentarios individuales 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 cheque
Generar comentarios de documentación XML para ///
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 software de documentación, y se incluyen en el resultado de compilación como un archivo assembly.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.
Visual Assist tiene una buena solución también, y es altamente costosa.
Después de ajustarlo para generar comentarios 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 del documento'' está en VassistX-> Opciones de ayuda visual-> Sugerencias, seleccione ''Editar fragmentos de VA'', Idioma: C ++, Tipo: Refactorización, luego vaya a ''Método del documento'' y personalice. El ejemplo anterior es generado por:
GhostDoc !
Haga clic derecho en la función, seleccione "Documentar 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 está autogenerado).
Tiene soporte para C #, VB.NET y C / C ++. Por defecto está mapeado 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 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 información nueva .
Habiendo dicho eso, personalmente prefiero que los métodos sean 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á una gran cantidad de mecanografía.
///
es el atajo 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 agregarla. Primero escribe el nombre de la función y la firma.
Luego, encima del nombre de la función solo escriba ///
y lo obtendrás automáticamente
