Comentario

A menudo citado como una de las convenciones de programación más útiles y menos utilizadas, un comentario es una nota de texto que se agrega al código fuente para proporcionar información explicativa, generalmente sobre la función del código. Los comentarios suelen ser útiles para alguien que mantiene o mejora su código cuando ya no está presente para responder preguntas al respecto. Los desarrolladores pares a veces evalúan el código por la integridad y legibilidad de sus comentarios.

Para permitir que el compilador del lenguaje de programación reconozca los comentarios y no los confunda con las instrucciones s, se utiliza un carácter especial (como "#", "/ *," "'" y "//") para señalar el principio o el final. de un comentario. Los caracteres de inicio del comentario HTML ( "); el texto dentro de estos caracteres de encuadre de comentarios es visible, sin embargo, para cualquiera que lea el código. Al leer esta página en un navegador web, por ejemplo, puede seleccionar" Ver "y luego" Fuente "para ver el código HTML de la página, incluidos los comentarios.

Un programa debe incluir al menos: a bloque de comentario de archivo que describe el contenido del archivo, de modo que alguien que lea el archivo pueda entenderlo sin tener que leer el código en sí, y un función bloque de comentarios que describe cada unidad funcional de código. Además, algunos codificadores proporcionan un comentario para cada declaración de idioma.