c++ - documentar - ¿Pueden las sugerencias de desplazamiento de Eclipse mostrar los comentarios de Doxygen del archivo de cabecera?
documentar codigo java (2)
Encontré una solución para este problema, sin embargo, es bastante inconveniente para el uso general.
Si está utilizando un sistema de compilación externo (make / cmake, por ejemplo,) donde eclipse no puede transmitir sus definiciones de macros, entonces todo lo que necesita hacer es colocar la implementación en su propia guarda de inclusión y agregar la macro incluir guardas a eclipse. Definiciones de símbolos. Esto ocultará esa sección de código del eclipse, obligándola a usar los comentarios deseados sin afectar la compilación.
Por ejemplo:
#ifndef INCLUDE_GUARD_FOR_IMPLEMENTATION
#define INCLUDE_GUARD_FOR_IMPLEMENTATION
// Implementation code
#endif
y luego en proyecto -> propiedades -> C / C ++ General -> Rutas y símbolos agregue INCLUDE_GUARD_FOR_IMPLEMENTATION en la sección de símbolos.
Por supuesto, tiene el efecto secundario de deshabilitar la sección, y si no puede o no quiere colocar el código de implementación en un encabezado separado, puede parecer que está fuera de lugar.
Estoy usando Eclipse CDT para escribir código C ++. Después de haber leído varias discusiones aquí en StackOverflow sobre si colocar la documentación de doxygen en el archivo de encabezado o en el archivo de implementación, parece que la mayoría de los desarrolladores prefieren poner comentarios de doxygen en el archivo de encabezado (aunque no es un consenso, por supuesto). Sin embargo, si pongo comentarios de doxygen en mis archivos de encabezado, no puedo hacer que Eclipse muestre esos comentarios cuando muevo el puntero del mouse sobre una instancia del método / miembro comentado. ¿Hay alguna manera de hacer que Eclipse haga uso de mi documentación de Doxygen de mis archivos de encabezado en las sugerencias de desplazamiento de Eclipse?
He configurado "Comentarios predeterminados en la herramienta de documentación del espacio de trabajo" en "Doxygen" en Preferencias> C / C ++> Editor.
Estoy usando Eclipse 3.6.2 con CDT 7.0.2 en Ubuntu 11.04.
Los comentarios de Doxygen se muestran en Eclipse al desplazarse cuando se escriben en:
- archivo cpp (o encabezado) archivo antes del origen del método (no declaración)
- archivo de cabecera antes de la declaración de clase