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?
Respuesta
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.
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.
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.
- ///
- //!
- /** */
- 1. Problema de barras inclinadas
- 2. Use barras inclinadas en sed replace
- 3. Reemplazar hacia atrás barras inclinadas con delanteros barras o barras invertidas dobles en C++
- 4. dos barras inclinadas en un/src atributo url/href
- 5. ¿Por qué usar #if 0 para comentar en bloque?
- 6. tecla de acceso directo botón/para comentar un bloque de código en Visual Studio 2008 Express
- 7. Cómo comentar un bloque de código Python en Vim
- 8. ¿Cómo puedo comentar un bloque de etiquetas en XML?
- 9. barras inclinadas posteriores en las URL de asp.net mvc con IIS 7
- 10. ¿Existe una función PHP que solo agregue barras inclinadas a comillas dobles? NO comillas simples
- 11. Habilitación de comentarios XML triple/tres barras en Visual Studio 2010 para C#
- 12. Acceso directo para comentar un bloque de código con texto sublime
- 13. Visual C# Express 2010 ¿Atajo para comentar un bloque de código?
- 14. Cómo obtener barras de progreso de estilo de bloque en Aero/.NET 4
- 15. ¿Cómo comentar una cadena en texto reestructurado?
- 16. ¿Cómo puedo comentar una sola línea o un bloque de líneas en Vim?
- 17. Comentar/descomentar un bloque de código en el atajo de NetBeans
- 18. ¿Hay alguna manera de comentar un gran bloque de código en TextMate?
- 19. Barras etiquetadas individualmente para gráficos de barras en matplotlib/Python
- 20. Cómo comentar/descomentar en el código HTML
- 21. Eliminar barras diagonales
- 22. ... (tres puntos) en jQuery?
- 23. Comentar SVN sin actualizar
- 24. En Java, ¿cuál es la sintaxis para comentar múltiples líneas?
- 25. Enlace para comentar dentro del tema en JIRA
- 26. Borde en tres lados
- 27. PHP: una buena forma de universalizar las rutas en todos los sistemas operativos (direcciones inclinadas)
- 28. ¿Cómo comentar en archivos de plantilla? (TPL)
- 29. Cómo comentar en XSLT y no HTML
- 30. ¿Cómo puedo comentar ERB en Rails?
¿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