Комментарии – это строки аннотации в коде Ruby, которые игнорируются во время выполнения. Однострочный комментарий начинается с символа #, и они простираются от # до конца строки следующим образом:
#!/usr/bin/ruby -w # Это однострочный комментарий. puts "Привет, Ruby!"
При выполнении вышеуказанной программы получается следующий результат:
Привет, Ruby!
Вы можете прокомментировать несколько строк, используя синтаксис = begin и = end следующим образом:
#!/usr/bin/ruby -w puts "Привет, Ruby!" =begin Это многострочный комментарий и он охватывает столько строк, сколько вам необходимо. Но =begin должен быть в начале и = end в конце. =end
При выполнении вышеуказанной программы получается следующий результат:
Привет, Ruby!
Убедитесь, что комментарии к комментариям достаточно далеко от кода и что их легко отличить. Если в блоке существует более одного комментария, выровняйте их. Например,
@counter # отслеживает время нахождения на странице @siteCounter # отслеживает время попадания всех страниц