1.2.2. Комментарии и встроенная документация

1.2.2. Комментарии и встроенная документация

Комментарии в Ruby начинаются со знака решетки (#), находящегося вне строки или символьной константы, и продолжаются до конца строки:

x = y + 5 # Это комментарий.

# Это тоже комментарий.

print "# А это не комментарий."

Предполагается, что встроенная документация будет извлечена из программы каким-нибудь внешним инструментом. С точки зрения интерпретатора это обычный комментарий. Весь текст, расположенный между строками, которые начинаются с лексем =begin и =end (включительно), игнорируется интерпретатором (этим лексемам не должны предшествовать пробелы).

=begin

Назначение этой программы - излечить рак

и установить мир во всем мире.

=end

Поделитесь на страничке

Следующая глава >

Похожие главы из других книг

7.3.7. Документация и CMM

Из книги Модель зрелости процессов разработки программного обеспечения автора Паулк Марк

7.3.7. Документация и CMM Ключевые практики описывают несколько документов, связанных с процессом, каждый из которых охватывает определенные области содержания. Ключевые практики не требуют соответствия «один к одному» между этими документами и реальными промежуточными


8.2.3 Бумажная документация

Из книги Информационная технология ПРОЦЕСС СОЗДАНИЯ ДОКУМЕНТАЦИИ ПОЛЬЗОВАТЕЛЯ ПРОГРАММНОГО СРЕДСТВА автора Автор неизвестен


3.2 Документация пользователя

Из книги ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ. РУКОВОДСТВО ПО УПРАВЛЕНИЮ ДОКУМЕНТИРОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ автора Автор неизвестен

3.2 Документация пользователя 3.2.1 Полнота (completeness) Документация пользователя должна содержать информацию, необходимую для использования продукта. В документации пользователя должны быть полностью описаны все функции, установленные в описании продукта, и все вызываемые


7.2.1. Документация разработки

Из книги Очень хороший самоучитель пользователя компьютером. Как самому устранить 90% неисправностей в компьютере и увеличить его возможности автора Колисниченко Денис Николаевич

7.2.1. Документация разработки Документы, описывающие процесс разработки программного обеспечения, определяют требования, которым должно удовлетворять программное обеспечение, определяют проект программного обеспечения, определяют, как его контролируют и как


Сгорела встроенная видеокарта

Из книги Объектно-ориентированный анализ и проектирование с примерами приложений на С++ автора Буч Гради

Сгорела встроенная видеокарта На некоторых материнских платах устанавливаются встроенные видеокарты для удешевления всей стоимости компьютера. Иногда (довольно редко) встроенные видеокарты выходят из строя. На некоторых материнских платах есть слот для установки


7.6. Документация

Из книги Основы объектно-ориентированного программирования автора Мейер Бертран

7.6. Документация Наследие разработки Разработка программной системы включает в себя гораздо больше, чем просто написание кода. Некоторые аспекты проекта должны быть постоянно доступны менеджерам разработки и внешним пользователям. Мы хотим также сохранить сведения о


Документация

Из книги Тайм-менеджмент для системных администраторов автора Лимончелли Томас

Документация Разработчики классов и систем должны обеспечивать руководство, заказчиков и других разработчиков ясными высокоуровневыми описаниями создаваемого ПО. Им необходим инструментарий, помогающий в этой работе. Большая часть документации должна автоматически


12 Документация

Из книги OrCAD PSpice. Анализ электрических цепей автора Кеоун Дж.

12 Документация В этой главе рассказывается, как хороший архив документов помогает системному администратору лучше работать и эффективнее управлять своим временем.Но вначале поговорим о том, почему мы не любим, боимся и вообще избегаем составлять документацию.Мы с


Встроенная модель для диода

Из книги Linux глазами хакера автора Флёнов Михаил Евгеньевич

Встроенная модель для диода Чтобы увидеть характеристику для встроенной модели диода в PSpice, можно провести анализ с вариацией входного напряжения на постоянном токе (dc sweep). Схема показана на рис. 9.3. При этом мы будем получать выходное напряжение «точка за точкой», строя


Встроенная модель биполярного транзистора

Из книги Программирование для Linux. Профессиональный подход автора Митчелл Марк

Встроенная модель биполярного транзистора В начальных главах мы не использовали при анализе транзисторных схем встроенную модель для плоскостного биполярного транзистора (BJT). Хотя одно из основных преимуществ PSpice заключается в широком диапазоне и многосторонности


14.1.5. Документация по безопасности

Из книги Как тестируют в Google автора Уиттакер Джеймс

14.1.5. Документация по безопасности Многие считают документацию уделом бюрократов и категорически не пишут никаких инструкций или других руководств. Я сам до поры до времени был таким и предпочитал следить за системой самостоятельно, пока она не стала слишком сложной, что


1.5.1. Интерактивная документация

Из книги Linux Mint и его Cinnamon. Очерки применителя автора Федорчук Алексей Викторович

1.5.1. Интерактивная документация В дистрибутивы Linux входят man-страницы с описанием большинства стандартных команд, системных вызовов и стандартных библиотечных функций. Интерактивная документация разбита на разделы, которым присвоены номера. Для программистов наиболее


Проектная документация

Из книги Идеальный программист. Как стать профессионалом разработки ПО автора Мартин Роберт С.

Проектная документация У каждого проекта в Google есть основной проектный документ. Это живой документ, он развивается вместе с проектом. Вначале этот документ описывает цель проекта, предпосылки его создания, предполагаемый список участников и архитектурных решений. На


Документация

Из книги автора

Документация Вы когда-нибудь использовали сторонние библиотеки? Фирма-разработчик обычно присылает красивое руководство с десятками глянцевых иллюстраций с кружочками и стрелочками; на обратной стороне каждой иллюстрации приводится абзац текста с описанием