Averigüemos qué son los comentarios y por qué son importantes en la programación.
También cubrimos dos tipos comunes de comentarios y cómo escribirlos en 15 lenguajes de programación diferentes.
Tabla de contenido
¿Qué son los comentarios en programación?
Los comentarios en términos simples son fragmentos de texto que no serán visibles para los usuarios finales y son para referencia de las personas que escriben código.
Un poco más formalmente, un comentario es una descripción de un programa sobre cómo funciona en un formato legible simple. Por lo general, se usan en lugares en los que se necesita proporcionar algo de 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 se requerirían para transferir conocimiento.
El compilador/intérprete simplemente ignora los comentarios en su código, por lo que no afecta el resultado final de su programa. Entonces, en pocas palabras, los comentarios son como una explicación simple y legible para ciertas piezas de 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 de varias líneas/Comentarios de bloque
Como sugiere el nombre, los comentarios de una sola línea son útiles cuando se necesita agregar texto pequeño de una sola línea, por ejemplo. una condición particular, un valor constante que necesita una pequeña descripción. Mientras que las líneas múltiples funcionan mejor cuando tenemos una mayor cantidad de información para agregar, como una descripción sobre una función y cómo se puede usar, etc.
Hay algunos otros tipos de comentarios, como los comentarios de documentos, pero eso está fuera del alcance de este artículo.
¿Por qué debería agregar comentarios?
“Cualquier tonto puede escribir un código que una computadora pueda entender. Los buenos programadores escriben código que los humanos pueden entender”. – Martín Fowler
La principal ventaja de agregar comentarios es la legibilidad mejorada y una mejor comprensión del programa. Aparte de esto, algunas otras ventajas incluyen:
- Los comentarios hacen que sea muy fácil para sus compañeros e incluso para otros desarrolladores comprender la lógica sin leer largas documentaciones.
- Comunicación reducida entre desarrolladores por pequeñas dudas.
- Los comentarios son ignorados por el compilador/intérpretes.
- Para el software de código abierto, estos son imprescindibles, ya que no estará allí para explicar cada función a millones de desarrolladores que quieran usar ese programa en particular.
Comentarios en varios idiomas
Impresionante, ahora que aprendimos sobre los comentarios y por qué son útiles. Exploremos cómo podemos agregar comentarios en diferentes lenguajes de programación.
Comentario de una sola línea
// This is a single line comment in C/C++
Comentario de varias líneas
/* This is slightly long multi line comment in C/C++ */
Comentario de una sola línea
# This is a single line comment in Python
Comentario de varias líneas
# This is slightly long # multi line comment in Python
Comentario de una sola línea
// This is a single line comment in Java
Comentario de varias líneas
/* This is slightly long multi line comment in Java */
Comentario de una sola línea
# This is a single line comment in Ruby
Comentario de varias líneas
=begin This is slightly long multi line comment in Ruby =end
Comentario de una sola línea
// This is a single line comment in Golang
Comentario de varias líneas
/* This is slightly long multi line comment in Golang */
Comentario de una sola línea
– – This is a single line comment in Haskell
Comentario de varias líneas
{- This is slightly long
multi line comment in Haskell -}
Comentario de una sola línea
// This is a single line comment in Rust
Comentario de varias líneas
/* This is slightly long multi line comment in Rust */
Comentario de una sola línea
<!-- This is a single line comment in HTML -->
Comentario de varias líneas
<!-- This is slightly long multi line comment in HTML -->
Comentario de una sola línea
/* This is a single line comment in CSS */
Comentario de varias líneas
/* This is slightly long multi line comment in CSS */
Comentario de una sola línea
// This is a single line comment in Javascript
Comentario de varias líneas
/* This is slightly long multi line comment in Javascript */
Comentario de una sola línea
# This is a single line comment in R programming language
Comentario de varias líneas
R no admite comentarios de varias líneas.
Comentario de una sola línea
% This is a single line comment in Erlang
Comentario de varias líneas
R no admite comentarios de varias líneas.
Comentario de una sola línea
// This is a single line comment in PHP
Comentario de varias líneas
/* This is slightly long multi line comment in PHP */
Comentario de una sola línea
# This is a single line comment in Perl
Comentario de varias líneas
=begin This is slightly long multi line comment in Perl =end
Comentario de una sola línea
// This is a single line comment in Kotlin
Comentario de varias líneas
/* This is slightly long multi line comment in Kotlin */
Conclusión
El tutorial cubrió los conceptos básicos sobre los comentarios y 2 tipos comunes: una sola línea y varias líneas. También traté de cubrir por qué los comentarios son útiles y uno debería escribirlos cuando sea necesario. ¡Espero que hayas aprendido algo nuevo!
Seguir explorando. ¡Seguir aprendiendo! 👨💻