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


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