generar - Genere comentarios de documentación XML para/// en Visual Studio 2010 C++

sandcastle documentation visual studio 2017

Question

Necesito comentar mi prototipo de función (escrito en C / C ++) con resumen, devoluciones, etiquetas param. ¿Cómo puedo persuadir a Visual Studio para que inserte etiquetas xml después de tres barras diagonales como en C #? Encontré una solución. Cuando renombro xx.h xx.cs en el proyecto C ++, puedo usar /// para generar comentarios xml (IntelliSense en comentarios xml también funciona). Debe haber una mejor manera, ¿no? Me mataría escribirlo manualmente. Agradeceré por cada comentario útil.

/// <summary>
/// 
/// </summary>
/// <param name="aa"></param>
/// <returns></returns>
bool function1(TypeX aa);

Answer 1

Esto se aplica a C ++ / CLI

Otra forma es usar ILSpy para convertir el código C ++ / CLI a C # . Luego, en C #, puedes escribir comentarios con el soporte de IntelliSence. Luego simplemente copie los comentarios en el proyecto C ++ / CLI, compile y estará bien :-)

Configurar Visual Studio (2013) para usar ILSpy

1. Descarga el binario de ILSpy
2. Agregue una nueva entrada de herramientas en Visual Studio abriendo "Herramientas / Herramientas externas / Agregar".
3. Allí ingrese la ruta a ILSpy.exe para Comando, $(TargetPath) para Argumentos y $(TargetDir) para el directorio inicial.
4. Aplicar y cerrar la ventana.
5. (Una nueva entrada aparece en la pestaña Herramientas)
6. Crear un nuevo proyecto C # vacío.

Usalo

Si luego abre cualquier archivo del proyecto C ++ / CLI y activa la nueva entrada en la pestaña Herramientas, aparece una ventana (ILSpy) que muestra su ensamblaje convertido al código C #. Copie ese código en un archivo ubicado en el proyecto C # y escriba comentarios XML.

Answer 2

Para C ++ / CLI

Estas instrucciones funcionan bien para la Visual Studio 2015 Update 2 .

Primero, active la documentación XML. Esto genera un archivo de metadatos, lo que significa que los comentarios serán visibles externamente, incluido C #.

A continuación, según la respuesta de @tcb , instale CppTripleSlash . Reinicie Visual Studio, y debería estar listo.

Answer 3

Echa un vistazo a este complemento: GhostDoc

Answer 4

En Visual Studio 2010 C ++, puede definir macros para insertar cosas por usted.

Defina una macro para insertar la línea de resumen del encabezado de la función básica.

/// <summary> </summary>

Otra para una línea de parámetro vacía, otra para una línea de retorno.

/// <param name=""> </param>

y

/// <returns> </returns>

Eso cubrirá la mayoría de sus necesidades con solo tres macros. Si los usa lo suficiente, agregue una macro para /// <remarks></remarks> y /// <exception name=""></exception> y <see cref=""/> y cualquier otra que no utilizar lo suficiente para hacer una macro para usted tendría que entrar manualmente.

Sí, tendrá que escribir el nombre del parámetro manualmente. :) Las macros no pueden hacer todo. :)

Ver: MSDN: VS2010: Cómo grabar macros

Ver: MSDN: VS2010: Cómo ejecutar macros

ACTUALIZACIÓN : no tenía conocimiento de estos hilos cuando escribí esta respuesta:

SO: Las macros no se ejecutan en VS2010

MS: Macros rotos en VS2010 por corrección de seguridad, febrero de 2014 (con una solución sugerida)

Answer 5

Esta funcionalidad no está incorporada. Puedes intentar usar los complementos de Visual Studio . No he usado Atomineer Utils Pro Documentation , pero parece prometedor. Genera comentarios de documentación y soporta C ++. Aunque cuesta $ 10.

Answer 6

GhostDoc ahora insertará comentarios XML para los elementos de C ++. Simplemente coloque el cursor en un elemento y presione Ctrl + Shift + D.

GhostDoc tiene una versión gratuita para uso personal que ya lo hará.

Answer 7

CppTripleSlash crea stubs de comentarios de documentos xml en archivos c ++ cuando se escribe ///, de forma similar a lo que está disponible para c # en Visual Studio. Esto también tiene algo de inteligencia básica para completar los comentarios de documentos XML.