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

💪 Или преминете направо към упражненията в този раздел.