¿Qué son los comentarios en Ruby?
Un comentario de Ruby agrega información a su código que puede ser útil para usted u otros desarrolladores.
El tipo de comentario más común es el comentario de una sola línea.
Aquí está la sintaxis:
# I like apples & oranges
Observe tres cosas:
- El comentario comienza con un símbolo de libra (
#) - Ponemos un espacio entre el contenido del comentario & el inicio del comentario para que sea más fácil leer
- Todo lo que hay dentro del comentario no se interpreta como código, incluso si parece código. Esto significa que puede comentar temporalmente el código para deshabilitarlo.
Puede usar estos comentarios por sí solos, o en línea, al final de una línea de código.
.size # get array size
hay otro tipo de comentarios?
Sí, hay comentarios mágicos, comentarios multilínea & comentarios ERB.
Vamos a explorar esos!
Cómo usar comentarios Multilínea en Ruby
En Ruby, hacemos comentarios multilínea con comentarios regulares de una sola línea.
Algunas personas llaman a estos»comentarios de bloque».
Este es un ejemplo:
# aaa# bbb# ccc
Así es exactamente como comentar un bloque de código en ruby.
Los editores de código modernos le permiten seleccionar un bloque de código & comentar todo usando un atajo de teclado, por lo que no implica un esfuerzo adicional.
Pero hay una sintaxis de comentarios multilínea especial.
Se parece a esto:
=beginThis is a comment...abc=end
Nadie usa esta sintaxis
Es feo & ni siquiera puedes usarla dentro de cualquier cosa que tenga sangría (como un método), pero es bueno saber que existe si alguna vez la encuentras en la naturaleza.
Comentarios SheBang
Un comentario shebang (#!) es un tipo especial de comentario que le dice a un shell de Unix (como bash) cómo interpretar este archivo.
Cuando añadas este comentario en la parte superior de tu archivo
Podrás ejecutar tus archivos Ruby como archivos ejecutables, suponiendo que tengan los permisos correctos para hacerlo.
Así es como se ve un comentario de shebang:
#!/usr/bin/env ruby
Esto también le permite establecer opciones específicas de línea de comandos, como la opción de advertencia.
Ejemplo:
#!/usr/bin/env ruby -w
Cada vez que ejecute este código, se ejecutará con estas opciones, por lo que no tendrá que pasarlas manualmente.
Cómo usar Comentarios mágicos
Un comentario mágico cambia el comportamiento del intérprete de Ruby de alguna manera.
Por ejemplo:
El comentario frozen_string_literals hará que tus cadenas se congelen de forma predeterminada.
Se parece a esto:
# frozen_string_literal: true
Otro comentario mágico le permite cambiar la codificación del archivo.
Este es un ejemplo:
# encoding: utf-8
A aquí hay una interesante, el comentario warn_indent:
# warn_indent: true
Esto mostrará una advertencia cuando la sangría sea incorrecta.
Ejemplo:
def comments end
Lo que resulta en:
warning: mismatched indentations at 'end' with 'def' at 3
Comentarios ERB
Si estás usando ERB para tus vistas Rails & necesitas añadir un comentario
Entonces puedes usar esta sintaxis:
No soy un gran fan de esto porque creo que debes mantener la mayor parte de tu lógica fuera de tus vistas para que no necesites comentarios.
¿Desea desactivar algún código para la depuración?
Luego elimina ese código & confía en git, o en cualquier sistema de control de versiones que estés usando.
Resumen
