Averigüemos 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, en términos sencillos, son trozos de texto que no serán visibles para los usuarios finales y que sirven de referencia a las personas que están escribiendo código.
Un poco más formalmente, un comentario es una descripción de un programa sobre su funcionamiento en un formato sencillo de leer. Suelen utilizarse en lugares en los que es necesario proporcionar cierta claridad adicional al desarrollador que está leyendo el código. Por lo tanto, esto ayuda a mejorar la legibilidad del código y reduce el tiempo y la comunicación que serían necesarios para transferir conocimientos.
El compilador/intérprete simplemente ignora los comentarios en su código, por lo que no afectan a la salida final de su programa. Así que, en pocas palabras, los comentarios son como una explicación sencilla y legible de ciertas partes del código.
Tipos comunes 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 uno necesita añadir un pequeño texto de una sola línea, por ejemplo, una condición particular, un valor constante que necesita una pequeña descripción. Mientras que los multilínea funcionan mejor cuando tenemos una mayor cantidad de información que añadir como una descripción sobre una función y cómo se puede utilizar, etc.
Existen otros tipos de comentarios, como los comentarios de documento, pero eso queda fuera del ámbito de este artículo.
¿Por qué debería 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 mayor ventaja de añadir comentarios es la mejora de la legibilidad y la mejor comprensión del programa. Aparte de esto, algunas otras ventajas incluyen
- Los comentarios facilitan enormemente que sus compañeros e incluso otros desarrolladores entiendan la lógica sin necesidad de leer largas documentaciones.
- Reducción de la comunicación entre desarrolladores por pequeñas dudas
- Los comentarios son ignorados por el compilador/interpretador.
- Para el software de código abierto, son imprescindibles, ya que usted no estará allí para explicar cada función a millones de desarrolladores que quieran utilizar ese programa en concreto.
Comentarios en varios idiomas
Impresionante, ahora que hemos aprendido acerca de los comentarios y por qué son útiles. Exploremos cómo podemos añadir comentarios en diferentes lenguajes de programación.
Comentarios en C/C
Comentario de una sola línea
// Este es un comentario de una sola línea en C/C
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en C/C */
Comentarios en Python
Comentario de una sola línea
# Este es un comentario de una sola línea en Python
Comentario multilínea
# Esto es ligeramente largo # comentario multilínea en Python
Comentarios en Java
Comentario de una sola línea
// Este es un comentario de una sola línea en Java
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en Java */
Comentarios en Ruby
Comentario de una sola línea
# Esto es un comentario de una sola línea en Ruby
Comentario multilínea
=comienzo Este es un comentario comentario multilínea en Ruby =fin
Comentarios en Golang
Comentario de una sola línea
// Este es un comentario de una sola línea en Golang
Comentario multilínea
/* Este es un comentario comentario multilínea en Golang */
Comentarios en Haskell
Comentario de una sola línea
- Este es un comentario de una sola línea en Haskell
Comentario multilínea
{- Este es un comentario
comentario multilínea en Haskell -}
Comentarios en Rust
Comentario de una sola línea
// Este es un comentario de una sola línea en Rust
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en Rust */
Comentarios en HTML
Comentario de una sola línea
Comentario multilínea
Comentarios en CSS
Comentario de una sola línea
/* Este es un comentario de una sola línea en CSS */
Comentario multilínea
/* Este es un comentario comentario multilínea en CSS */
Comentarios en JavaScript
Comentario de una sola línea
// Este es un comentario de una sola línea en Javascript
Comentario multilínea
/* Este es un comentario comentario multilínea en Javascript */
Comentarios en R
Comentario de una sola línea
# Este es un comentario de una sola línea en el lenguaje de programación R
Comentario multilínea
R no admite comentarios multilínea.
Comentarios en Erlang
Comentario de una sola línea
% Esto es un comentario de una sola línea en Erlang
Comentario multilínea
R no soporta comentarios multilínea.
Comentarios en PHP
Comentario de una sola línea
// Este es un comentario de una sola línea en PHP
Comentario multilínea
/* Este es un comentario comentario multi-línea en PHP */
Comentarios en Perl
Comentario de una sola línea
# Este es un comentario de una sola línea en Perl
Comentario multilínea
=comienzo Este es un comentario comentario multilínea en Perl =fin
Comentarios en Kotlin
Comentario de una sola línea
// Este es un comentario de una sola línea en Kotlin
Comentario multilínea
/* Este es un comentario comentario multilínea en Kotlin */
Conclusión
El tutorial cubrió lo básico sobre los comentarios y 2 tipos comunes – Single y Multi-line. También traté de cubrir por qué son útiles los comentarios y uno debe escribirlos cuando sea necesario. ¡Espero que haya aprendido algo nuevo!
Siga explorando. ¡Siga aprendiendo! 👨💻