Курс 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 →

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