什么是记录Perl代码的最佳方式？

问题描述：

任何建议如何我可以记录我的Perl代码？你使用什么和有什么工具可以帮助我？什么是记录Perl代码的最佳方式？

您使用哪个模块将pod转换为html？

De gustibus。我个人比较喜欢Doxygen（Doxygen :: Filter :: Perl）到POD。 – 2014-08-21 08:57:53

答

几乎查看任何Perl模块，您将看到Plain Old Documentation (POD)格式。在CPAN Search上查看模块时，您可以选择查看原始数据源，这是您查看原始数据源的一种方法，但您也可以使用命令行中的perldoc。该-m开关显示了文件

perldoc -m Foo::Bar

或者，如果你想找到的文件，所以你可以看看它在你喜欢的编辑器，使用-l开关找到它：

perldoc -l Foo::Bar

一旦你开始记录你的程序，你把Pod放在代码中的文件中，或者与代码交织在一起，所以文档在相关部分旁边，或者在开始，中间或结束时作为一个大块。

使用Perl附带的译码器（pod2latex，pod2ps，pod2html），Pod可以轻松转换为其他几种格式，例如LaTeX，Postscript，HTML等。我甚至有一个转到InDesign的pod翻译器。使用Pod::Simple编写自己的Pod翻译器非常简单，所以如果您没有找到您最喜欢的最终形式的翻译器，只需自己制作即可。

还有几种工具可以添加到测试套件中以检查Pod。 Test::Pod模块检查格式错误，Test::Pod::Coverage模块检查您已记录每个子例程，等等。您也可能对我的Perl documentation documentation感兴趣。

答

Perl pod。

这就是Mozilla如何记录他们的Perl。

答

不要过度翻转，但记录Perl代码的最佳方式与您用任何其他语言编写代码的方式相同。

至于具体的工具，我用的标准内联注释，荚混合较大的文件，其中类似人的格式是合适的，TeX的大块作为需要更*的文件是最终的后备。（并且，本着“与其他语言相同”的精神，是的，我也使用pod来记录非Perl代码。）

答

我绝对推荐POD。

POD也可以与代码一起使用，但我更喜欢在__END__之后放置程序的底部（如Damian Conway在Perl Best Practices中所建议的那样）。

请看POD::Server & POD::Webserver，它为您的所有POD提供网络前端。

答

您使用哪个模块将pod 转换为html？

退房Pod::ProjectDocs - 你得到一个简单的命令行实用工具，将所有的POD转换成你的Perl项目分成一组看起来就像你看到search.cpan.org什么HTML页面。

现在在某些情况下，它是hande [Mojolicious :: Plugin :: PODRenderer]（http://mojolicious.org/perldoc/Mojolicious/Plugin/PODRenderer） – 2016-12-28 12:10:31

答

您可能还想看到Damian Conway的Perl Best Practices。我使用了一些技巧来清理我继承的一个小的Perl代码库。

答

没有人提到Smart::Comments？这并不总是你想要的，但是如果你需要更多的权力来评论，那就很好。

这个模块非常棒。有点惊讶我从来没有听说过它。无法告诉你我已经写了多少次子程序来完成这个模块可以提供的部分内容，不能推荐它。 – slm 2011-10-26 01:39:36

答

单独的用户文档和编码器文档。也许把用户文档（tuts，faq，reference）放在目录（/ doc）和编码器的代码中。不幸的是，它通过修改预期在模块本身中进行概述。这你可以像已经铺好的POD后END。鬃毛编码文件，你可以在评论中。额外的东西，如编码风格或如何贡献放在代码库（根目录？）内的独立.pod文件？

什么是记录Perl代码的最佳方式？

相关推荐