o que são comentários em Ruby?
um comentário em Ruby adiciona informações ao seu código que podem ser úteis para si ou para outros programadores.
o tipo mais comum de comentário é o comentário de linha única.
aqui está a sintaxe:
# I like apples & oranges
repare em três coisas.:
- O comentário começa com uma libra (
#) símbolo - Vamos colocar um espaço entre o conteúdo do comentário & o início do comentário para facilitar a leitura
- Tudo dentro do comentário não seja interpretado como código, mesmo que ele se parece com o código. Isso significa que você pode comentar temporariamente o código para desativá-lo.
pode utilizar estes comentários por si só, ou em linha, no final de uma linha de código.Existem outros tipos de comentários?
Sim, existem comentários mágicos, comentários multi-lines & comentários ERB.Vamos explorar isso!
Como Usar Comentários multi-linhas em Ruby
em Ruby, fazemos comentários multi-linhas com comentários regulares e únicos.
algumas pessoas chamam estes “comentários em bloco”.
aqui está um exemplo:
# aaa# bbb# ccc
é exactamente como comentar um bloco de código em ruby.
os editores de código modernos permitem-lhe seleccionar um bloco de código & comentar tudo isto usando um atalho de teclado, por isso não há esforço extra envolvido.
mas há uma sintaxe especial de comentários multi-linhas.
parece-se com isto:
=beginThis is a comment...abc=end
ninguém usa esta sintaxe…
é feio & você não pode sequer usá-lo dentro de qualquer coisa que é indentado (como um método), mas é bom saber que existe se você alguma vez encontrá-lo na natureza.
shebang Comments
a shebang (#!) é um tipo especial de comentário que diz a um shell Unix (como bash) como interpretar este arquivo.
quando adicionar este comentário no topo do seu ficheiro …
poderá executar os seus ficheiros Ruby como ficheiros executáveis, assumindo que eles tenham as permissões certas para o fazer.
aqui está o que um comentário shebang parece:
#!/usr/bin/env ruby
isto também lhe permite definir opções específicas da linha de comandos, como a opção de aviso.Exemplo:
#!/usr/bin/env ruby -w
cada vez que você executar este código ele irá correr com estas opções, para que você não tenha que passá-los manualmente.
Como Usar Comentários mágicos
um comentário mágico muda o comportamento do interpretador de Ruby de alguma forma.
por exemplo:
o comentário frozen_string_literals fará com que suas cordas fiquem congeladas por padrão.
parece-se com isto:
# frozen_string_literal: true
outro comentário mágico permite-lhe alterar a codificação do ficheiro.
aqui está um exemplo:
# encoding: utf-8
aqui está um interessante, o comentário warn_indent:
# warn_indent: true
isto irá mostrar um aviso sempre que a sua indentação estiver errada.Exemplo:
def comments end
o que resulta em:
warning: mismatched indentations at 'end' with 'def' at 3
comentários ERB
se estiver a usar ERB para as suas vistas de Carris & tem de adicionar um comentário…
então pode usar esta sintaxe:
eu não sou um grande fã disso, porque eu acredito que você deve manter a maior parte de sua lógica fora de suas opiniões para que você não deve precisar de quaisquer comentários.
procurando desactivar algum código para depuração?
em seguida, delete esse código & confie em Git, ou qualquer sistema de controle de versão que você está usando.
resumo
