Comentario (programación de computadoras)


En la programación de computadoras , un comentario es una explicación o anotación legible por el programador en el código fuente de un programa de computadora . Se agregan con el propósito de hacer que el código fuente sea más fácil de entender para los humanos y, por lo general, los compiladores e intérpretes los ignoran . [1] [2] La sintaxis de los comentarios en varios lenguajes de programación varía considerablemente.

A veces, los comentarios también se procesan de varias formas para generar documentación externa al propio código fuente mediante generadores de documentación , o se utilizan para la integración con sistemas de gestión de código fuente y otros tipos de herramientas de programación externas .

La flexibilidad proporcionada por los comentarios permite un amplio grado de variabilidad, pero las convenciones formales para su uso suelen formar parte de las guías de estilo de programación.

Los comentarios generalmente tienen el formato de comentarios de bloque (también llamados comentarios de prólogo o comentarios de transmisión ) o comentarios de línea (también llamados comentarios en línea ). [3]

Los comentarios de bloque delimitan una región del código fuente que puede abarcar varias líneas o una parte de una sola línea. Esta región se especifica con un delimitador inicial y un delimitador final . Algunos lenguajes de programación (como MATLAB ) permiten que los comentarios de bloque se aniden recursivamente uno dentro de otro, pero otros (como Java ) no lo permiten. [4] [5] [6]

Los comentarios de línea comienzan con un delimitador de comentario y continúan hasta el final de la línea o, en algunos casos, comienzan en una columna específica (desplazamiento de línea de caracteres) en el código fuente y continúan hasta el final de la línea. [6]


Una ilustración del código fuente de Java con comentarios de prólogo indicados en rojo y comentarios en línea en verde . El código del programa está en azul .