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

Основы Pod

Документация Pod находится в вашем исходном файле и выделяется строками, начинающимися с =. Самый простой способ написать блок документации — поместить его между =begin pod и =end pod:

=begin pod

=head1 My Module

This module does something useful.

=end pod

Внутри блока директивы описывают структуру:

• =head1, =head2, … — заголовки разных уровней
• обычный абзац — просто текст на отдельных строках
• =item — элемент маркированного списка

=begin pod

=head1 Features

=item Fast
=item Small
=item Simple

=end pod

Строка =head1 — это заголовок верхнего уровня; три строки =item формируют список. Pod располагается рядом с вашим кодом, не влияя на него — компилятор игнорирует его при выполнении программы, но может извлечь и отрисовать его по запросу, как показано в последней теме.

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

← Документирование кода   |   Тест — Pod →

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