Perl支持把你的pod格式文字块生成文档,这个pod格式文字块可以是植入在代码里的标记语言,也可以是单独的一个文件。

有了pod,只要在写脚本的时候,随手记下想法、说明,就不用再另外编写文档了,非常方便。

建议先仔细读一读perldoc perlpod里面的内容,文档详细介绍了pod标记语言的语法。

$ perldoc perlpod

尽量保证一个比较好的书写习惯,例如:

=pod

=head1 NAME

Water::Test – The great new Water::Test!

=head1 VERSION

Version 0.01

=cut

开始和结束都应该要空一行。当你用如上形式写到你的代码文件里后,你只要用pod2html, pod2man之类的命令,就可以把它转为文档。

例如,如果你把上面的代码保存为test.txt文件,则用如下命令可以把它转为html文档:

$ pod2html –infile test.txt –outfile text.html