Курс языка программирования Raku / Продвинутый уровень / Тестирование и документация 🆕 / Документирование кода

Доступ к Pod

Помимо отрисовки, программа может читать свой собственный Pod изнутри, во время выполнения. Специальная переменная $=pod содержит Pod текущего файла в виде списка блочных объектов, поэтому программа может просматривать свою собственную документацию:

=begin pod
=head1 Hello
A paragraph.
=end pod

say $=pod.elems;      # 1
say $=pod[0].name;    # pod

В данном примере $=pod содержит один элемент — блок pod — и вы можете углубиться в него, чтобы прочитать заголовки, абзацы и элементы как данные. Именно на этом основана работа инструментов, которые генерируют документацию или проверяют её наличие. Независимо от того, отрисована ли документация с помощью --doc или прочитана через $=pod, она является полноценной частью программы, а не комментарием, который будет удалён.

Навигация по курсу

← Рендеринг Pod   |   Форматированный текст →

💪 Или перейдите сразу к упражнениям этого раздела.