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

Форматирование и код

Внутри текста Pod вы размечаете слова с помощью однобуквенных кодов форматирования, которые записываются как буква, за которой следуют угловые скобки вокруг текста:

  • B<…> — жирный
  • I<…> — курсив
  • C<…> — код (моноширинный)
  • L<…> — ссылка
=begin pod

This is B<important>, and C<say> is a built-in.

=end pod

При отрисовке слово important отображается жирным шрифтом, а say — моноширинным. Коды могут быть вложенными и комбинироваться, так что B<C<say>> — это жирный код.

Для целого блока кода, а не встроенного фрагмента, используйте ограниченный блок кода — =begin code … =end code — который сохраняет текст дословно:

=begin pod

Here is how to call it:

=begin code
say greet('world');
=end code

=end pod

Строки внутри блока кода отображаются именно так, как написаны, без интерпретации как Pod. Благодаря встроенным кодам и блокам кода Pod позволяет документировать API с форматированным текстом и примерами, похожими на выполняемый код, — всё это рядом с описываемым кодом.

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

← Тест — Pod   |   Рендеринг Pod →


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