17.1.2. Более сложное форматирование
17.1.2. Более сложное форматирование
RDoc позволяет довольно точно управлять тем, какие части исходного текста документируются и как к ним следует относиться. Для этого служат специальные теги в комментариях (модификаторы документации).
Одним из самых важных является тег :nodoc:, отключающий вывод документации для определенного фрагмента. Обычно он ставится в той же строке, где начинается определение класса или метода.
class Alpha # :nodoc:
class Beta
# ...
end
# ...
end
Здесь класс Alpha не будет документироваться. Однако тег :nodoc: не является рекурсивным — класс Beta документируется. Если желательно рекурсивное
поведение, укажите :nodoc: all. В следующем примере игнорируются оба класса Gamma и Delta:
class Alpha # :nodoc: all
class Beta
# ...
end
# ...
end
Имеется также модификатор :doc: с прямо противоположным смыслом. Он включает документацию для фрагментов, которые иначе не были бы документированы.
Модификатор :notnew: специальный; он предотвращает документирование метода new (на основе существующего метода initialize).
Если вы хотите дать осмысленные имена параметрам yield, воспользуйтесь тегом :yields:. Например, если в самом тексте употребляются ничего не значащие имена x и у, то в документации их можно заменить.
def iterate # :yields: element, index
# ...
yield x, i
end
Некоторые теги используются только внутри блока комментариев, например:
• :include: — включить содержимое указанного файла в документацию. При этом будут сформированы подходящие отступы;
• :titlе: — задать заголовок документа;
• :main: — задать начальную страницу документации.
Дополнительную информацию вы найдете в книге «Programming Ruby» или в любом онлайновом справочном руководстве.
Более 800 000 книг и аудиокниг! 📚
Получи 2 месяца Литрес Подписки в подарок и наслаждайся неограниченным чтением
ПОЛУЧИТЬ ПОДАРОКДанный текст является ознакомительным фрагментом.
Читайте также
14.3. Более точное время
14.3. Более точное время Системный вызов time() и тип time_t представляют время в секундах в формате отсчета с начала Эпохи. Разрешения в одну секунду на самом деле недостаточно, сегодняшние машины быстры, и часто бывает полезно различать временные интервалы в долях секунды.
Более сложный случай
Более сложный случай Хотя это только базовый шаблон, для более сложных ситуаций может оказаться нелегко выяснить первопричину утечки. Распространенной практикой по написанию объектно-ориентированного JScript является расширение DOM-элементов путем инкапсуляции их внутри
2.7. Более сложные сценарии
2.7. Более сложные сценарии Смысл празднования дня рождения ребенка весьма приближенно передается тем определением, которое можно найти, например, в толковом словаре: день рождения — это «прием гостей, устраиваемый по случаю дня рождения». Прием здесь может, в свою
Более сложный Web-сценарий
Более сложный Web-сценарий Теперь сделаем что-нибудь посложнее — заставим пункты списков, формирующих полосу навигации на Web-странице index.htm, менять цвет рамки при наведении на них курсора мыши. Так мы дадим посетителю понять, что данные элементы Web-страницы могут
21.8 Более простой сервер
21.8 Более простой сервер Многие серверы разрабатываются как в показанном выше примере. Однако можно использовать более упрощенную модель, когда сервер должен выполнять только простые запросы клиента (см. ниже).Вместо создания дочернего процесса для каждого клиента
9.2.4. Более строгая реализация очереди
9.2.4. Более строгая реализация очереди Мы определим очередь примерно так же, как стек. Если вы хотите защититься от некорректного доступа к структуре данных, рекомендуем поступать аналогично.class Queue def initialize @store = [] end def enqueue(x) @store << x end def dequeue @store,shift end def peek
10.2.2. Более сложный маршалинг
10.2.2. Более сложный маршалинг Иногда мы хотим настроить маршалинг под свои нужды. Такую возможность дают методы _load и _dump. Они вызываются во время выполнения маршалинга, чтобы вы могли самостоятельно реализовать преобразование данных в строку и обратно.В следующем примере
11.1.3. Более сложные конструкторы
11.1.3. Более сложные конструкторы По мере усложнения объектов у них появляется все больше атрибутов, которые необходимо инициализировать в момент создания. Соответствующий конструктор может оказаться длинным и запутанным, его параметры даже не будут помещаться на одной
11.2. Более сложные механизмы
11.2. Более сложные механизмы Не все в модели ООП, реализованной в Ruby, одинаково очевидно. Что-то сложнее, что-то применяется реже. Линия раздела для каждого программиста проходит в разных местах. В этой части главы мы попытались собрать те средства, которые не так просты или
СВЯЗИ: Более равны, чем другие
СВЯЗИ: Более равны, чем другие Автор: Родион НасакинЗнаменитый оруэлловский лозунг: «Все животные равны, но некоторые равны более, чем другие» незаметно берут на вооружение сотовые операторы и интернет-провайдеры, считающие, что могут дозировать скорость трафика в сетях
Анатолий Вассерман: Китай осваивает сложное Анатолий Вассерман
Анатолий Вассерман: Китай осваивает сложное Анатолий Вассерман Опубликовано 11 марта 2011 года "Компьюлента" сообщает: "Китай создал суперкомпьютер на основе собственных процессоров". Правда, процессоры разработаны далеко не с нуля: в их основе давно
Более сложные трансформации
Более сложные трансформации От простого — к сложному. Это вечный путь познания. Последуем им и мы.Сложные трансформации графики (вращение, сдвиг, изменение размеров и пр.) выполняются во Flash 8 с помощью особого инструмента, называемого Free Transform (Трансформатор). Чтобы
Более сложное движение
Более сложное движение Flash-аниматоры, как начинающие, так и опытные, очень любят такой эффект: какой-либо фрагмент изображения постепенно исчезает или, наоборот, появляется на экране. Это похоже на то, как на фотографии, опущенной в раствор проявителя, постепенно возникает
Более сложные эффекты
Более сложные эффекты Закончив с эффектами простейшими, перейдем к более сложным и более, если так можно сказать, эффектным. Их побольше — целых