Doxygen & Documentación de código - Funcionalidades

Vista previa de la documentación

Consulte la vista previa de la documentación de Doxygen en la ventana emergente Quick Documentation (Ctrl+Q). Los comandos de Doxygen se analizan y alinean allí ordenadamente, junto con el tipo de información.

Si los parámetros de la función se documentan por separado de la descripción de la función, CLion fusionará todos los comentarios y le mostrará la documentación completa de la función (al igual que hace Doxygen cuando genera la salida).

Cambiar nombre de forma segura

Para mantener la documentación correcta, utilice la refactorización Rename Shift+F6 para actualizar el nombre de la función o sus parámetros. CLion obtendrá los comentarios de Doxygen actualizados, así como otras referencias.

Utilizar finalización

Para ayudarle a escribir más rápido, CLion viene con finalización automática de comandos y parámetros de función de Doxygen.

Generar documentación

Para añadir un nuevo comentario de Doxygen para una función, simplemente genérelo. Escriba /**, /*!, /// o //! y luego pulse Intro. En caso de que su función tenga parámetros, devuelva un valor o arroje una excepción, se generará un stub.

Quick Documentation

La ventana emergente de documentación rápida Quick Documentation(Ctrl+Q) es una herramienta universal que le ayuda a obtener más información sobre un elemento de código en el signo de intercalación. De forma predeterminada, CLion muestra la documentación rápida en una ventana emergente al pasar el ratón de forma automática. Dependiendo del elemento para el que se invoque, la ventana emergente puede incluir:

Detalles de la firma de la función.
Documentación del código (comentarios normales o de Doxygen).
Tipos inferidos, que es especialmente valioso para el C++ moderno que puede carecer de tipos explícitos.
El tamaño del tipo.
Sustituciones de macros para ayudarle a entender y depurar mejor las macros anidadas.
Valores de expresiones constantes.
Valor Enum como un entero.