¿Por qué escribir comentarios? Aunque el buen código tiende a ser auto-descriptivo, a menudo es útil realizar comentarios en el margen. Es un error creer que otras personas que examinen el código comprendan inmediatamente lo que se pretendía hacer. Aparte, y desde una perspectiva práctica, quién de nosotros no ha tenido que realizar una corrección o mejora en un programa después de un cierto periodo de tiempo y decir: he escrito esto, pero ¿qué demonios se supone que hace?
Algunos programadores experimentados señalarán, con bastante razón, que comentarios contradictorios o desactualizados pueden ser peor que ningún comentario en absoluto. Evidentemente, los comentarios no deben ser un sustituto de un código legible; si el código es poco claro, es probable que también sea erróneo. Es probable que se necesite
comentar más cuando se está aprendiendo Ruby y menos cuando se llegue a expresar las ideas en código sencillo, elegante y legible.
Ruby sigue el convenio, común entre los lenguajes de guiones, de utilizar el símbolo de la almohadilla para indicar el comienzo de un comentario. El interprete ignora cualquier cosa que siga a una almohadilla, que no esté entre comillas, hasta el final de la línea en la que aparece Para facilitar la escritura de grandes bloques de comentarios el interprete también ignora cualquier cosa comprendida entre una línea inicial con =begin y una final con =end.
#!/usr/bin/ruby
=begin
***********************************************************************
Este es un bloque de comentarios, algo que se escribe en beneficio de los lectores (incluido uno mismo). El interprete lo ignora. No hay necesidad de utilizar ’#’ al comienzo de cada línea
***********************************************************************
=end
