为 Perl 编写 POD 注释有什么约定吗？

Question

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

为 Perl 脚本编写 POD 注释时应遵循哪些约定？有没有类似的东西 Sun 的 Javadoc 约定, ，但是对于 POD 评论呢？

Answer 1

这不细说了，但我喜欢Juerd的 perlpodtut 引进了很多。

在作者提到了他认为是共同的部分和他们将包括。

Answer 2

有一组在 Perl的最佳实践建议。第7章的全覆盖文档，使用POD，最好的办法，以文档模块，大型项目等，还约CPAN公约的谈判。这可能是你最好的选择。

Answer 3

Perl::评论家 提供以下政策：

• Perl::Critic::政策::文档::PodSpelling

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

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

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

所需部分的列表 由上面最后一个策略提供。

模块::启动器::PBP 将为您生成样板代码。

Answer 4

您可以查看POD上 CPAN搜索 Perl模块，迅速记下的东西，每个人都没有。各个模块在启动工具使样板给你。

这是关于尽可能靠近你会得到指引。