Книга: Программирование на языке Ruby
1.2.2. Комментарии и встроенная документация
1.2.2. Комментарии и встроенная документация
Комментарии в Ruby начинаются со знака решетки (#), находящегося вне строки или символьной константы, и продолжаются до конца строки:
x = y + 5 # Это комментарий.
# Это тоже комментарий.
print "# А это не комментарий."
Предполагается, что встроенная документация будет извлечена из программы каким-нибудь внешним инструментом. С точки зрения интерпретатора это обычный комментарий. Весь текст, расположенный между строками, которые начинаются с лексем =begin и =end (включительно), игнорируется интерпретатором (этим лексемам не должны предшествовать пробелы).
=begin
Назначение этой программы - излечить рак
и установить мир во всем мире.
=end
Оглавление книги
Похожие страницы
- Комментарии
- Комментарии (comments)
- 18 Документация: объяснение кода в Web-сообществе
- Как создавать комментарии к файлам?
- Комментарии к алгоритму Тоома—Кука
- 14.1.5. Документация по безопасности
- 16.7. Дополнительная документация
- Строки кода и комментарии
- Комментарии в программе
- 10.6. Дополнительная документация
- 14. Оцифровка Визуальная документация за рамками встречи
- Комментарии к примеру простой системы "производитель