POD 格式

內聯(lián)文檔及格式

POD 允許你在 Perl 代碼中使用標記來創(chuàng)建文檔。如果你見過 Javadoc 或 PHPdoc， 它跟它們很相像。

POD 是語言的一部分，并非額外的規(guī)范。

使用?=head1?和?=head2?創(chuàng)建標題

=head1 MOST IMPORTANT

Blah blah

=head2 Subheading

blah blah

=head2 Subhading

blah blah

創(chuàng)建無序列表

要創(chuàng)建這樣的列表：

• Wango
• Tango
• Fandango

使用：

=over

=item * Wango

=item * Tango

=item * Fandango

=back

創(chuàng)建有序列表

要創(chuàng)建下面的列表：

1. Visit perl101.org
2. ???
3. Profit!

使用：

=over

=item 1 Visit perl101.org

=item 2 ???

=item 3 Profit!

=back

使用內聯(lián)標記樣式

POD 用?B<>、I<>?及?C<>?分別表示粗體、斜體、代碼。

B<This is bolded>

I<This is italics>

C<This is code>

標記格式能夠嵌套。

使用?L<>?超鏈接

L<>?既可以鏈接文檔中的關鍵字，如?L<Methods>；也可以鏈接 URL，如L<http://search.cpan.org。

段落模式 vs. 字面塊

段落會自動換行，并由至少一個空行分隔。

A literal block is indented at least one space
and does not
get
wrapped.

這來自于：

Everything in a paragraph word-wraps automatically.  A paragraph
is separated by at least one blank line.

    A literal block is indented at least one space
    and does not
    get
    wrapped.

POD 不會使程序運行變慢

它將在編譯時被去除。