Ruby - Комментарии

Комментарии - это строки аннотации в коде Ruby, которые игнорируются во время выполнения. Однострочный комментарий начинается с символа # и простирается от # до конца строки следующим образом:

#!/usr/bin/ruby -w
# This is a single line comment.

puts "Hello, Ruby!"

При выполнении вышеуказанная программа дает следующий результат -

Hello, Ruby!

Многострочные комментарии Ruby

Вы можете прокомментировать несколько строк, используя =begin и =end синтаксис следующим образом -

#!/usr/bin/ruby -w

puts "Hello, Ruby!"

=begin
This is a multiline comment and con spwan as many lines as you
like. But =begin and =end should come in the first line only. 
=end

При выполнении вышеуказанная программа дает следующий результат -

Hello, Ruby!

Убедитесь, что завершающие комментарии находятся достаточно далеко от кода и легко различимы. Если в блоке существует более одного завершающего комментария, выровняйте их. Например -

@counter      # keeps track times page has been hit
@siteCounter  # keeps track of times all pages have been hit