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


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