Me preguntaba si hay una forma (con suerte, 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 automáticamente 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)
Respuestas:
Haga que "tres marcadores de comentarios únicos"
En C # es ///
que por defecto escupe:
/// <summary>
///
/// </summary>
/// <returns></returns>Aquí hay algunos consejos sobre cómo editar plantillas de VS.
GhostDoc !
Haga clic con el botón derecho en la función, seleccione "Documentar esto" y
private bool FindTheFoo(int numberOfFoos)
se convierte en
/// <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 ++. Se asigna de forma predeterminada a Ctrl+ Shift+ D.
Recuerde: debe agregar información más allá de la firma del método a la documentación. No se limite a la documentación generada automáticamente. 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 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á una gran cantidad de mecanografía.
///
es el atajo para obtener el bloque de comentarios de la descripción del método. Pero asegúrese de haber escrito el nombre de la función y la firma antes de agregarla. Primero escriba el nombre y la firma de la función.
Luego, encima del nombre de la función, simplemente escriba ///
y lo obtendrás automáticamente
Visual Assist también tiene una buena solución y es muy personalizable.
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)
{
}
(Bajo la configuración predeterminada, es un poco diferente).
Editar: la forma de personalizar el texto del 'método de documento' es en VassistX-> Opciones de asistencia visual-> Sugerencias, seleccione 'Editar fragmentos de código VA', Idioma: C ++, Tipo: Refactorización, luego vaya a 'Método de documento' y personalice. El ejemplo anterior es generado por:
Normalmente, Visual Studio lo crea automáticamente si agrega tres marcadores de comentario únicos encima de lo que le gusta 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 comprobar
Genere comentarios de documentación XML para ///
En Visual Basic, si crea su función / sub primero, luego en la línea de arriba, escribe 'tres veces, se generará automáticamente el xml relevante para la documentación. Esto también aparece cuando pasa el mouse por encima en intellisense y cuando está utilizando la función.
Puede utilizar 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 podrá completar.
Estos comentarios XML pueden ser interpretados por software de documentación y se incluyen en el resultado de la compilación como un archivo assembly.xml. Si conserva ese archivo XML con la DLL y hace referencia a esa DLL en otro proyecto, esos comentarios estarán disponibles en intellisense.
Estoy trabajando en un proyecto de código abierto llamado Todoc que analiza palabras para producir una salida de documentación adecuada automáticamente al guardar un archivo. Respeta los comentarios existentes y es realmente rápido y fluido.