是否有任何为Perl编写POD注释的约定？

Question

我能够从Safari Books Online找到提供a template的页面，但是从未写过POD评论，我不确定它有多好，或者它是否遗漏了任何可能被视为惯例的内容。包括

为Perl脚本编写POD注释时要遵循哪些约定？是否有类似Sun's Javadoc Conventions的内容，但对于POD评论？

Answer 1

Perl Best Practices中有一系列建议。第7章的内容涵盖了使用POD的文档，以及模块，大型项目等文档的最佳方法。它还讨论了CPAN约定。这可能是你最好的选择。

Answer 2

这不详细，但我非常喜欢Juerd的perlpodtut介绍。

提交人提到了他认为的共同部分及其包含的内容。

Answer 3

Perl::Critic提供以下政策：

• Perl::Critic::Policy::Documentation::PodSpelling

• Perl::Critic::Policy::Documentation::RequirePackageMatchesPodName

• Perl::Critic::Policy::Documentation::RequirePodAtEnd

• Perl::Critic::Policy::Documentation::RequirePodSections

A list of required sections由上述最后一项政策提供。

Module::Starter::PBP将为您生成样板代码。

Answer 4

您可以在CPAN Search上查看Pod for Perl模块，并快速记下每个人所做的事情。各种模块启动工具为您制作样板。

这就像你接近指南一样接近。