Los comentarios implican colocar descripciones legibles para el hombre dentro de los programas de computadora que detallan lo que está haciendo el Código . El uso adecuado de los comentarios puede hacer que el mantenimiento del código sea mucho más fácil, así como ayudar a que los errores sean más rápidos. Además, comentar es muy importante a la hora de escribir funciones que otras personas utilizarán. Recuerde, un código bien documentado es tan importante como un código que funciona correctamente.
Todos los programas deben comentarse de tal manera que describan fácilmente el propósito del código y cualquier algoritmo utilizado para lograrlo. Un usuario debe poder utilizar un programa (o función) previamente escrito sin tener que mirar el código, simplemente leyendo los comentarios.
Comentar es el "arte" de describir lo que su programa va a hacer siendo la mejor manera de comentar es antes de escribir el código para su programa.
Los comentarios son líneas de texto especialmente marcadas en el programa que no se evalúan. Normalmente hay dos formas sintácticas de comentar. El primero se llama comentario de una sola línea y, como está implícito, solo se aplica a una sola línea en el "código fuente" (el programa). El segundo se denomina comentario de bloque y se refiere generalmente a un párrafo de texto. Un comentario de bloque tiene un símbolo de inicio y un símbolo de fin y todo lo que se encuentra entre se ignora por la computadora.
GAS:
- Use // para una sola línea.
- Todo lo que va desde el // hasta el final de esa línea del archivo es ignorado por el programa y es solo para uso del lector humano del código.
- Usar / * para líneas múltiples * /
Bibliografía: https://www.cs.utah.edu/~germain/PPS/Topics/commenting.html