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

Question

我能够从Safari Books Online找到一个提供模板的页面 ，但是从未写过POD评论，我不确定它有多好，或者它是否遗漏了任何可能被认为包含的惯例。

为Perl脚本编写POD注释时要遵循的约定是什么？ 是否有类似Sun的Javadoc约定 ，但对于POD评论？

Answer 1

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

Answer 2

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

作者提到了他认为的共同部分以及它们将包含的内容。

Answer 3

Perl :: Critic提供以下政策：

• Perl的::评论家::策略::文档:: PodSpelling

• Perl的::评论家::策略::文档:: RequirePackageMatchesPodName

• Perl的::评论家::策略::文档:: RequirePodAtEnd

• Perl的::评论家::策略::文档:: RequirePodSections

上面的上一个策略提供了必需部分的列表 。

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

Answer 4

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

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