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.
¿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 están escribiendo código.
Un poco más formalmente, A comentario es una descripción de un programa sobre cómo funciona en un formato legible simple. Por lo general, se usan en lugares donde se debe brindar 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 conocimientos.
Compilador/ Interpreter simplemente ignora los comentarios en su código, por lo tanto, no afecta la salida final de su programa. Entonces, en pocas palabras, los comentarios son como una explicación simple y legible para ciertos fragmentos 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
- Comentarios 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 otros tipos de comentarios, como 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 ". - Martin Fowler
La principal ventaja de agregar comentarios es la mayor legibilidad y 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 entender la lógica sin leer largas documentaciones.
- Reducida comunicación entre desarrolladores para pequeñas dudas
- El compilador / intérprete ignora los comentarios.
- 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
Genial, ahora que aprendimos sobre los comentarios y por qué son útiles. Exploremos cómo podemos agregar comentarios en diferentes lenguajes de programación.
Comments in C/C++
Comentario de una sola línea
// Este es un comentario de una sola línea en C / C ++
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en C / C ++ * /
Comments in Python
Comentario de una sola línea
# Este es un comentario de una sola línea en Python
Comentario de varias líneas
# Este es un comentario un poco largo # de varias líneas en Python
Comments in Java
Comentario de una sola línea
// Este es un comentario de una sola línea en Java
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en Java * /
Comments in Ruby
Comentario de una sola línea
# Este es un comentario de una sola línea en Ruby
Comentario de varias líneas
= comenzar Este es un comentario de varias líneas un poco largo en Ruby = fin
Comments in Golang
Comentario de una sola línea
// Este es un comentario de una sola línea en Golang
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en Golang * /
Comments in Haskell
Comentario de una sola línea
- - Este es un comentario de una sola línea en Haskell
Comentario de varias líneas
{- Este es un comentario de varias líneas un poco largo en Haskell -}
Comments in Rust
Comentario de una sola línea
// Este es un comentario de una sola línea en Rust
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en Rust * /
Comments in HTML
Comentario de una sola línea
Comentario de varias líneas
Comments in CSS
Comentario de una sola línea
/ * Este es un comentario de una sola línea en CSS * /
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en CSS * /
Comments in JavaScript
Comentario de una sola línea
// Este es un comentario de una sola línea en Javascript
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en Javascript * /
Comments in R
Comentario de una sola línea
# Este es un comentario de una sola línea en Programación R idioma
Comentario de varias líneas
R no admite comentarios de varias líneas.
Comments in Erlang
Comentario de una sola línea
% Este es un comentario de una sola línea en Erlang
Comentario de varias líneas
R no admite comentarios de varias líneas.
Comments in PHP
Comentario de una sola línea
// Este es un comentario de una sola línea en PHP
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en PHP * /
Comments in Perl
Comentario de una sola línea
# Este es un comentario de una sola línea en Perl
Comentario de varias líneas
= comenzar Este es un comentario de varias líneas un poco largo en Perl = fin
Comments in Kotlin
Comentario de una sola línea
// Este es un comentario de una sola línea en Kotlin
Comentario de varias líneas
/ * Este es un comentario de varias líneas un poco largo en Kotlin * /
Conclusión
El tutorial cubrió los conceptos básicos sobre los comentarios y 2 tipos comunes: una línea y varias líneas. También traté de explicar por qué los comentarios son útiles y uno debe escribirlos cuando sea necesario. ¡Espero que hayas aprendido algo nuevo!
Seguir explorando. ¡Seguir aprendiendo! 👨💻
