Ejemplo de adición de comentarios en 15 lenguajes de programación

Veamos qué son los comentarios y por qué son importantes en programación.

También cubrimos dos tipos comunes de comentarios y cómo escribirlos en 15 lenguajes de programación diferentes.

¿Qué son los comentarios en programación?

Los comentarios son fragmentos de texto que no serán visibles para los usuarios finales y que sirven de referencia a las personas que escriben el código.

Un poco más formalmente, A comentario es una descripción de un programa sobre su funcionamiento en un formato sencillo y legible. Suelen utilizarse en aquellos lugares en los que es necesario proporcionar más claridad al desarrollador que está leyendo el código. Esto ayuda a mejorar la legibilidad del código y reduce el tiempo y la comunicación necesarios para transferir conocimientos.

Compilador/Interpreter simplemente ignora los comentarios en su código, por lo que no afecta a la salida final de su programa. En pocas palabras, los comentarios son como una explicación sencilla y legible de ciertas partes del código.

Tipos habituales de comentarios

La mayoría de los lenguajes de programación admiten 2 tipos de comentarios.

Comentario de una sola línea
Comentario multilínea / Comentarios en bloque

Como su nombre indica, los comentarios de una sola línea son útiles cuando se necesita añadir un texto pequeño de una sola línea, por ejemplo, una condición concreta, un valor constante que necesita una pequeña descripción. Mientras que los comentarios multilínea funcionan mejor cuando tenemos que añadir una mayor cantidad de información, como una descripción de una función y cómo utilizarla, etc.

Existen otros tipos de comentarios, como los comentarios de documentos, pero eso queda fuera del ámbito de este artículo.

¿Por qué añadir comentarios?

"Cualquier tonto puede escribir código que un ordenador pueda entender. Los buenos programadores escriben código que los humanos pueden entender". - Martin Fowler

La principal ventaja de añadir comentarios es la mayor legibilidad y mejor comprensión del programa. Aparte de esto, otras ventajas son

Los comentarios hacen que sea muy fácil para tus compañeros e incluso para otros desarrolladores entender la lógica sin tener que leer largas documentaciones.
Menor comunicación entre desarrolladores ante pequeñas dudas
Los comentarios son ignorados por el compilador/intérpretes.
En el caso del software de código abierto, son imprescindibles, ya que no podrá explicar cada función a millones de desarrolladores que quieran utilizar ese programa concreto.

Comentarios en varios idiomas

Impresionante, ahora que hemos aprendido acerca de los comentarios y por qué son útiles. Vamos a explorar cómo podemos añadir comentarios en diferentes lenguajes de programación.