sugerencias - trucos de eclipse

Cambia el estilo de comentario de doxygen en Eclipse

Question

¿Alguien sabe cómo editar el estilo utilizado para los comentarios de Doxygen en Eclipse CDT?

En otras palabras, escriba / ** y presione Intro en una línea antes de que una función actualmente me dé algo como:

/**
 * 
 * @param one
 * @param two
 * @return
 */
Foo(int one, int two);

Y quiero que me de algo como:

/**********************************************************************/
///
/// /param one
/// /param two
/// /return
/***********************************************************************/
Foo(int one, int two);

Además, más uno si alguien sabe cómo enlazar esto con un método abreviado de teclado (como alt - shift - j para Eclipse JDT).

Además, para su información, el hecho de que Eclipse CDT sea compatible con Doxygen ahora parece ser un hecho poco conocido basado en Google. Vea here para más detalles. Doxygen se puede habilitar en las propiedades del proyecto seleccionando "Habilitar configuraciones específicas del proyecto" en la pestaña "C / C ++ General" y seleccionando "Doxygen". Mi versión de CDT es 7.0.1, pero creo que estuvo disponible en 5.0.

Por último, la sección de comentarios bajo plantillas de código en las preferencias no logra esto en base a mis pruebas.

EDITAR: ver here . Parece que el estilo del comentario está codificado. Si alguien encuentra lo contrario, me encantaría saberlo. Supongo que las plantillas serán lo mejor por ahora a menos que el estilo Javadoc esté bien para ti.

Answer 1

Esta es una configuración que encontré en mi comentario de java.

y cuando edité como se muestra, el comentario de mi documento de Java cambió a

Trate de buscar una configuración similar en su configuración de PHP.

Answer 2

Puedo obtener una parte de lo que desea al ir a: Preferencias - PHP - Estilo de código - Plantillas de código - Comentarios.

No estoy seguro de que esto le permita usar barras invertidas en lugar de @s para sus palabras clave, pero creo que debería lograr la mayoría de lo que desea.

Answer 3

Sí, esto parece ser un error en Eclipse CDT.

Como solución alternativa, le sugiero que cree una plantilla personalizada a la que se pueda acceder con la combinación de teclas Ctrl + Espacio .

En Eclipse Helios: Ventana -> Preferencias -> C / C ++ -> Editor -> Plantillas

Haga clic en Nuevo ... para crear una nueva plantilla y en el campo Nombre use un nombre descriptivo, por ejemplo, "función de comentario", y agregue su comentario de doxygen en el campo Patrón . Confirmar y aplicar este cambio.

En su código, puede ir a la línea sobre la declaración de su función, escriba las primeras letras del nombre de su plantilla personalizada seguido de la combinación de teclas Ctrl + Espacio .

En este ejemplo:

com<Ctrl+space>

Aparecerá el cuadro de diálogo Asistencia de contenido filtrado con "com *" en el que puede seleccionar la plantilla "función de comentario".

Nota:

com<Ctrl+space+space>

filtrará aún más al mostrar solo las Propuestas de plantilla en la ventana emergente Asistencia de contenido.

Answer 4

Una etiqueta de Doxygen utiliza este formato básico.

/**
Your tags and such. It MUST have the /** and the */.
*/

Absolutamente debe tener el / ** * / alrededor de todo el comentario de Doxygen. Si modifica las Plantillas de Código, hará lo que quiera.

Sin embargo, el estilo de comentario propuesto es incorrecto.

/***************/ <-- These are terminated Doxygen blocks.
/// <-- These are used in xml style Doxygen blocks.
///
/// This isn''t actually a Doxygen block and shouldn''t work
/// if you run Doxygen on it.
///
/***************/ <-- These are terminated Doxygen blocks.

Esto a continuación es estándar para la mayoría de las empresas que codifican JAVA y eclipse. Dado que Doxygen es válido para múltiples idiomas, esto también es válido para C / C ++.

/**
 * Brief description.
 *
 * @param[in|out] <value> <description>
 */

Si quieres usar las etiquetas de estilo xml ...

/// <summary>
/// This is a summary of the class, blah, blah.
/// </summary>

También querrá asegurarse de que eclipse no inserte otros estilos de comentarios, de lo contrario puede terminar con comentarios insertados dentro de otros comentarios. En general, también es una mala regla mezclar estilos de comentarios como / ** * / y ///.

Finalmente, si selecciona los comentarios de generación automática al crear clases y esos comentarios se incluirán automáticamente. Y puede tener eclipses de encabezado de métodos de generación automática a medida que escribe (aunque olvido cómo lo hice).