Tres barras inclinadas para comentar en bloque?

Noté esto por primera vez en Notepad ++, donde // comentarios y /// comentarios se mostraron en diferentes colores.
Doxygen reveló más sobre esto, pero no estoy convencido de su eficacia.
1. ¿Por qué alguien usaría el estilo de comentarios de tres recortes cuando es mucho más fácil escribir /* y */? (Me imagino que tiene que haber una explicación mejor que útil al anidar los comentarios)
2. Para que sea útil, los editores admiten el bloqueo de comentarios para barras diagonales triple en la forma en que Visual Studio tiene soporte para Ctrl+k Ctrl+c para múltiples ¿comentarios en línea?Tres barras inclinadas para comentar en bloque?

Fuente

2012-02-08 Nav

¿Estás usando Doxygen? Esto es más de por qué Doxygen recomienda '///' en lugar de '/ * * /' para la documentación del código C++. – birryree

Sería '/ ** * /' para la documentación. –

Ok, entonces es para documentación. Pensé que era una forma alternativa/mejor de hacer comentarios de varias líneas. – Nav

En Visual Studio, el /// indica documentation no solo comentarios. Siguiendo su enlace, la explicación es la misma. Se utiliza para adornar los comentarios que serán formateadas específicamente a través de su editor o alguna otra herramienta para documentar la clase, método, espacio de nombres, etc.

Fuente

2012-02-08 03:56:07 linuxuser27

Esto es menos Visual Studio y más específico de C#. C++ en Visual Studio obviamente puede tener '///' comentarios, pero no tienen ningún significado especial, y el doc-comment-viewer también mostrará comentarios '//' o '/ * * /'. – ssube

Aún no lo entiendo. Quiero comentar, por ejemplo una función como, que cuando mi mouse esté sobre ella, mi comentario estará visible o en el menú, cuando pueda elegir las funciones de clase. ¿Como hacer eso? –

¿Existe algún atajo para documentar? Es aburrido crear 3 '/' todo el tiempo. Ctrl + K crea 2 '/', no 3 .. – Arkady

Sin duda, es más fácil para golpear tres veces la misma tecla que no golpear dos por separado llaves.
No sé de otros IDEs, pero XCode4 admite fragmentos de código donde puede escribir casi cualquier cosa. En Visual Studio, uso Visual Assist X, que me da lo mismo. XCode4 Example, Visual AssistX example. Tendría que suponer que otros IDE proporcionan una funcionalidad similar.

Dicho esto, sí, también me he encontrado con las barras diagonales triples y generalmente se utilizan para indicar los comentarios que un sistema de auto documentación como doxygen podría elegir.

Fuente

2012-02-08 03:57:55 Carl

Visual Assist X también tiene la opción extender-multilínea-comentarios, que se usa con los fragmentos hace que los comentarios '/ ** * * /' casi no funcionen. – ssube

El autor podría intención de poner la documentación después de ///

En donde trabajo, utilizamos 3 estilos de bloques de comentarios doxygen para la documentación porque la falta de guías de estilo de codificación.

///
//!
/** */

Fuente

2012-02-08 04:02:17 grokus

Tres barras inclinadas para comentar en bloque?

Respuesta

Cuestiones relacionadas