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.
Comentarios en C/C++
Comentario de una sola línea
// Esto es un comentario de una sola línea en C/C++
Comentario multilínea
/* Esto es ligeramente largo comentario de varias líneas en C/C++ */
Comentarios en Python
Comentario de una sola línea
# Esto es un comentario de una sola línea en Python
Comentario multilínea
# Esto es un poco largo # comentario multilínea en Python
Comentarios en Java
Comentario de una sola línea
// Esto 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 Esto es ligeramente largo comentario multilínea en Ruby =fin
Comentarios en Golang
Comentario de una sola línea
// Esto es un comentario de una sola línea en Golang
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en Golang */
Comentarios en Haskell
Comentario de una sola línea
-Esto es un comentario de una sola línea en Haskell
Comentario multilínea
{- Esto es ligeramente largo comentario multilínea en Haskell -}
Comentarios en Rust
Comentario de una sola línea
// Esto es un comentario de una sola línea en Rust
Comentario multilínea
/* Este es un comentario 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
/* Esto es un comentario de una sola línea en CSS */
Comentario multilínea
/* Esto es ligeramente largo comentario de varias líneas en CSS */
Comentarios en JavaScript
Comentario de una sola línea
// Esto es un comentario de una sola línea en Javascript
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en Javascript */
Comentarios en R
Comentario de una sola línea
# Se trata de un comentario de una sola línea en Programación R idioma
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 admite comentarios multilínea.
Comentarios en PHP
Comentario de una sola línea
// Esto es un comentario de una sola línea en PHP
Comentario multilínea
/* Esto es ligeramente largo comentario multilínea en PHP */
Comentarios en Perl
Comentario de una sola línea
# Esto es un comentario de una sola línea en Perl
Comentario multilínea
=comienzo Esto es ligeramente largo comentario multilínea en Perl =fin
Comentarios en Kotlin
Comentario de una sola línea
// Esto es un comentario de una sola línea en Kotlin
Comentario multilínea
/* Esto es ligeramente largo comentario de varias líneas en Kotlin */
Conclusión
El tutorial cubrió los conceptos básicos sobre los comentarios y 2 tipos comunes - Single y Multi-line. También traté de cubrir por qué los comentarios son útiles y uno debe escribirlos cuando sea necesario. Espero que hayas aprendido algo nuevo.
Sigue explorando. Sigue aprendiendo. 👨💻