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

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