¿Hay algo como GhostDoc para C ++

Question

Cuando estoy desarrollando en C #, yo utilizo en gran medida GhostDoc para acelerar el proceso de comentar mi código. Actualmente estoy trabajando en un proyecto de C ++ y no he encontrado una herramienta equivalente. Yo sé de Doxygen, pero por lo que sé que se utiliza para crear la documentación fuera del código, no comentarios en el código. ¿Hay buenas herramientas equivalentes? Yo preferiría que se ejecuta en VS, pero que podría manejar una que funciona en cualquier IDE.

(Antes de que alguien saca el tema, no se basan únicamente en GhostDoc para crear comentarios. Yo sólo lo uso para crear el punto de partida para mis comentarios.)

Answer 1

ayuda visual ayuda al proporcionar scripts personalizados ejecutados mientras se escribe (o en otra).

Por ejemplo, se puede tener un guión de comentarios como este:

/************************************************************************/
/* My comment : $end$                                                                     */
/************************************************************************/

Eso se sugirió (a través de un cuadro combinado exactamente como Intellisense) al empezar a escribir "/ **", por ejemplo. Al seleccionar esta sugerencia (a través de Enter / Espacio / Click - personalizable), se insertará el guión se encuentra el cursor y simplemente reemplazar los marcadores que se encuentran entre los caracteres '$' por valores especiales (como el nombre del archivo actual, por ejemplo). Aquí el marcador de $ $ final hará que el cursor esté en esta posición cuando se ejecuta la secuencia de comandos. De esta forma, continuar escribiendo sin problemas. Por ejemplo, con el conjunto de la escritura anterior, escribiendo exactamente:

/** this is a test comment to show you one of the many features Visual Assit!

simplemente dar:

/************************************************************************/
/* My comment : this is a test comment to show you one of the many features Visual Assit!                                                                     */
/************************************************************************/

Es muy fácil de personalizar y el comportamiento de la sugerencia (léase: intelisense ++). Sistema es personalizable

Answer 2

He escrito un complemento, Atomineer Pro Documentación que es muy similar a GhostDoc (genera comentarios de la documentación / actualizaciones a ahorrar mucho tiempo y esfuerzo en la catalogación), sino que analiza el código directamente por sí mismo y por lo tanto es capaz de manejar C, C ++, C ++ / CLI, C #, Java y el código de Visual Basic, y no requiere el código que rodea a estar en un estado de compilar antes de que funcione. También añadirá automáticamente la documentación / actualización para las cosas más difíciles, tales como las excepciones lanzadas dentro del cuerpo de un método.

Se ejecuta bajo Visual Studio 11, 2010, 2008 y 2005, y es compatible con documentación en XML, Doxygen, JavaDoc y Qt formatos de comentarios, así como el formato / estilo de bloques de comentarios y las reglas de auto-doc utilizado siendo altamente configurable . Tiene una serie de otras características útiles tales como ayudar a las conversiones de los doc-legacy comentarios a los formatos anteriores, y el ajuste de texto en los doc-comentarios y observaciones normales de bloque.

Lo anterior es sólo un resumen de algunas de las características clave - Este comparación de las características con otra productos sirve como una lista más completa de las muchas otras características disponibles.

Answer 3

ayuda visual podría hacer el trabajo, aunque no estoy completamente seguro.