Consejos

Usar comentarios en Ruby

Usar comentarios en Ruby

Los comentarios en su código Ruby son notas y anotaciones destinadas a ser leídas por otros programadores. El intérprete de Ruby ignora los comentarios en sí mismos, por lo que el texto dentro de los comentarios no está sujeto a ninguna restricción.

Por lo general, es una buena forma poner comentarios antes de las clases y métodos, así como cualquier pieza de código que pueda ser compleja o poco clara.

Uso efectivo de comentarios

Los comentarios deben usarse para dar información de fondo o anotar código difícil. Las notas que simplemente dicen lo que hace la siguiente línea de código directo no solo son obvias sino que también agregan desorden al archivo.

Es importante tener cuidado de no usar demasiados comentarios y asegurarse de que los comentarios en el archivo sean significativos y útiles para otros programadores.

El shebang

Notarás que todos los programas de Ruby comienzan con un comentario que comienza con #!. Esto se llama un el asunto y se usa en sistemas Linux, Unix y OS X.

Cuando ejecutas un script Ruby, el shell (como bash en Linux u OS X) buscará un shebang en la primera línea del archivo. El shell luego usará el shebang para encontrar el intérprete Ruby y ejecutar el script.

El ruby ​​shebang preferido es #! / usr / bin / env ruby, aunque también puedes ver #! / usr / bin / ruby o #! / usr / local / bin / ruby.

Comentarios de una sola línea

El comentario de una línea de Ruby comienza con el # carácter y termina al final de la línea. Cualquier personaje de la # el intérprete de Ruby ignora por completo el carácter al final de la línea.

los # el carácter no necesariamente tiene que aparecer al comienzo de la línea; Puede ocurrir en cualquier lugar.

El siguiente ejemplo ilustra algunos usos de los comentarios.

#! / usr / bin / env ruby

# Esta línea es ignorada por el intérprete de Ruby

# Este método imprime la suma de sus argumentos

suma def (a, b)

pone a + b

fin

suma (10,20) # Imprime la suma de 10 y 20

Comentarios multilínea

Aunque a menudo es olvidado por muchos programadores de Ruby, Ruby tiene comentarios de varias líneas. Un comentario de varias líneas comienza con el = comenzar ficha y termina con el = fin simbólico.

Estas fichas deben comenzar al principio de la línea y ser lo único en la línea. Cualquier cosa entre estas dos fichas es ignorada por el intérprete de Ruby.

#! / usr / bin / env ruby

= comenzar

Entre = comienzo y = fin, cualquier número

de líneas pueden ser escritas. Todos estos

el intérprete de Ruby ignora las líneas.

= fin

pone "¡Hola mundo!"

En este ejemplo, el código se ejecutaría como ¡Hola Mundo!