Warning: file_get_contents(/data/phpspider/zhask/data//catemap/8/perl/11.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
为Perl编写POD注释有什么约定吗?_Perl_Perl Pod - Fatal编程技术网

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

为Perl编写POD注释有什么约定吗?,perl,perl-pod,Perl,Perl Pod,我在Safari Books Online上找到了一个提供POD评论的页面,但我从来没有写过POD评论,我不确定它有多好,或者它是否遗漏了任何可能被认为是惯例的内容 为Perl脚本编写POD注释时要遵循哪些约定?除了POD评论之外,还有什么类似的吗?中有一组建议。第7章的全部内容涵盖了文档、POD的使用以及模块、大型项目等文档的最佳方法。它还讨论了CPAN约定。这可能是您的最佳选择。提供了以下策略: 由上面最后一个策略提供 将为您生成样板代码。虽然不详细,但我非常喜欢Juerd的介绍

我在Safari Books Online上找到了一个提供POD评论的页面,但我从来没有写过POD评论,我不确定它有多好,或者它是否遗漏了任何可能被认为是惯例的内容


为Perl脚本编写POD注释时要遵循哪些约定?除了POD评论之外,还有什么类似的吗?

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

提供了以下策略:

由上面最后一个策略提供


将为您生成样板代码。

虽然不详细,但我非常喜欢Juerd的介绍


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

您可以查看上面的Perl模块的Pod,并快速注意到每个人都做的事情。各种模块启动工具为您制作样板


这差不多就是你能找到的指导方针。

你知道这些指导方针是否可以在网上免费获得吗?我喜欢这本书的建议(特别是因为它看起来非常完整和深入),但是免费提供一些东西让我开始学习是最好的。@Thomas Owens:我不认为这本书的任何内容都可以在网上免费获得。Sinan与Perl::Critic的链接很好。另一个选择是查看一些核心CPAN模块的文档。虽然方法可能有所不同,但有一些标准章节等,作为指导方针很有帮助。“编写Pod的提示”与内容无关。我可能应该把我的问题编辑得更清楚一些,但我特别关注内容和设计(分段、标题、缩进…)惯例。我正在查看RequiredSections,以修改我查看的模板,尝试对其进行改进。是的,RequiredSections文档的默认RequiredSections部分+1。我用它来修改我链接到的原始模板。我想我有一些像样的东西,比我刚开始的要好。