Cómo comentar en Ruby
Los comentarios son simplemente información agregada al código fuente de un programa para fines de documentación. Los intérpretes y los compiladores de idiomas ignoran los comentarios. Aunque el uso principal de los comentarios es documentar y describir las operaciones de un bloque de código, pueden ser convenientes al depurar su código.
En este tutorial, aprenderemos varias formas de comentar código en Ruby Scripts.
Uso básico: comentarios de una sola línea
Hay varios tipos de comentarios en Ruby. Sin embargo, el más básico es un comentario de una sola línea.
Comienza con un símbolo de libra (#) y continúa hasta el final de la línea.
# Comentario de una sola línea rubíImprimir "Hola desde Ruby!"
Como puede ver en el ejemplo anterior, el comentario de una sola línea comienza con el símbolo de libra y se extiende hasta el final de la línea.
El intérprete Ruby ignora el texto dentro del comentario de una sola línea, incluso si tiene un código de rubí válido.
Un comentario de una sola línea en Ruby puede comenzar al comienzo de una línea o al final, como se muestra a continuación:
Imprimir "Hola desde Ruby!" # Comentario de una sola línea de rubyEn este caso, el contenido antes del signo de libra (#) se cuenta como código de rubí válido, mientras que el contenido después no es.
Comentarios en bloque/múltiples líneas
En otros casos, debe describir lo que el código hace de una manera más detallada. Para incluir comentarios que abarcan múltiples líneas en Ruby, implementamos comentarios de bloque.
Hay dos formas de implementar comentarios en bloque en Ruby:
1: = begin/= End
Este método utiliza el formato = begin y = final para encerrar las líneas dentro del bloque como comentarios.
Aquí hay un ejemplo:
= comenzarEste es un comentario
que abarca múltiples líneas
y es muy útil para la documentación detallada
= final
Imprimir "Hola comentarios de bloque!"
En este tipo de comentario, comenzamos usando la palabra clave = BEGIN seguido de todas las líneas en las que deseamos comentar y cerrar con = End.
El uso de este formato de comentarios es raro porque no ofrece mucha flexibilidad en el formato de los comentarios, y es muy ilegible.
2: símbolos de múltiples libras (#)
La forma más común de comentar múltiples líneas en Ruby es pre-aplicar cada línea con un signo de libra.
Aquí hay un ejemplo:
# Este es otro método de comentarios# que abarca múltiples líneas
# Y es muy útil para la documentación detallada
En este caso, tenemos múltiples líneas comentadas. Usando editores modernos, puede resaltar un bloque de código y comentarlo a la vez.
Comentarios y comentarios mágicos
Ruby es un idioma interesante porque ofrece comentarios mágicos. Los comentarios mágicos toman un formato similar a los comentarios regulares, pero en lugar de ser ignorados por el intérprete, cambian el comportamiento del intérprete.
Los comentarios mágicos contienen directivas Ruby que definen qué modificar sobre el intérprete.
El ejemplo a continuación muestra un comentario mágico para modificar la codificación de literales de cadena.
# Codificación: UTF-8Aunque lo anterior se parece a un comentario regular, contiene una directiva reconocida por Ruby.
Para obtener más información sobre las directivas de comentarios mágicos, considere la documentación de los comentarios de Ruby.
Resumen
Esta guía rápida discutió varios tipos de comentarios de rubí, que incluyen cómo implementarlos con facilidad.