Comentários no seu Rubi código são notas e anotações que devem ser lidas por outros programadores. Os comentários em si são ignorados pelo intérprete Ruby, portanto, o texto dentro dos comentários não está sujeito a nenhuma restrição.
Geralmente, é uma boa forma colocar comentários antes das classes e métodos, bem como qualquer parte do código que possa ser complexa ou pouco clara.
Usando comentários efetivamente
Os comentários devem ser usados para fornecer informações básicas ou anotar códigos difíceis. Observa que simplesmente diz o que a próxima linha de código simples faz não é apenas óbvio, mas também adiciona confusão ao arquivo.
É importante tomar cuidado para não usar muitos comentários e garantir que os comentários feitos no arquivo sejam significativos e úteis para outros programadores.
The Shebang
Você notará que todos os programas Ruby começam com um comentário que começa com #!. Isso é chamado de shebang e é usado em sistemas Linux, Unix e OS X.
Quando você executa um script Ruby, o shell (como o bash no Linux ou OS X) procura um shebang na primeira linha do arquivo. O shell usará o shebang para encontrar o intérprete Ruby e executar o script.
O ruby shebang preferido é #! / usr / bin / env ruby, embora você também veja #! / usr / bin / ruby ou #! / usr / local / bin / ruby.
Comentários de linha única
O comentário de linha única do Ruby começa com o # caractere e termina no final da linha. Qualquer caractere do # O caractere até o final da linha é completamente ignorado pelo intérprete Ruby.
o # o personagem não precisa necessariamente ocorrer no início da linha; isso pode ocorrer em qualquer lugar.
O exemplo a seguir ilustra alguns usos dos comentários.
#! / usr / bin / env ruby
# Esta linha é ignorada pelo intérprete Ruby
# Este método imprime a soma de seus argumentos
soma def (a, b)
coloca a + b
fim
sum (10,20) # Imprima a soma de 10 e 20
Comentários de várias linhas
Embora muitas vezes esquecido por muitos programadores de Ruby, Ruby tem comentários de várias linhas. Um comentário de várias linhas começa com o = começar token e termina com o = final símbolo.
Esses tokens devem começar no início da linha e ser a única coisa na linha. Qualquer coisa entre esses dois tokens é ignorada pelo intérprete Ruby.
#! / usr / bin / env ruby
= começar
Entre = begin e = end, qualquer número
de linhas podem ser escritas. Todos esses
linhas são ignoradas pelo intérprete Ruby.
= final
coloca "Olá mundo!"
Neste exemplo, o código seria executado como Olá Mundo!