Как оставлять комментарии в Ruby-коде?
Для того, чтобы оставить комментарий в Ruby-коде используется знак решетки (#).
Комментарии обозначенные решеткой - продолжаются до конца строки.Примеры использования комментариев в Ruby-коде:
cat_name = "Пёс" # Да, кличка моей кошки - “Пёс” # Люди иногда хотят уточнить, правда ли это кличка кошки, а не кота cat_gender = "Женский" # Уточняю пол моей кошки.
# Для описания больших участков кода # можно использовать несколько строк # и желательно описывать то, что находится ниже: def cat_name_choosing # logic here end
Иногда нет необходимости в проставлении большого количества решеток (если у нас много строк), а стоит воспользоваться лексемами "=begin" и "=end".
После символа равенства не должно быть пробелов, а документация заключается внутри лексем:
=begin Моя бесконечная история про котиков будет тут. =end
Кроме упомянутых способов оставлять комментарии в Ruby-коде, ознакомьтесь с "HEREDOC" - способом писать большие куски документации и передавать их в переменные (при необходимости).