Курс 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   |   Форматований текст →

💪 Або перейдіть одразу до вправ цього розділу.