有关如何记录我的Perl代码的任何建议吗？您使用了什么以及可以使用哪些工具来帮助我？
您使用哪个模块将pod转换为html？
答案 0 :(得分：47)
查看几乎所有Perl模块，您将看到Plain Old Documentation (POD)格式。在CPAN Search上，在查看模块时，您可以选择查看原始源，这样您就可以通过一种方式查看原始窗格，但也可以从命令行使用perldoc。 -m开关显示文件
perldoc -m Foo::Bar
或者，如果您想查找文件以便在您喜欢的编辑器中查看，请使用-l开关查找：
perldoc -l Foo::Bar
一旦你开始记录你的程序，你就把Pod放在正确的代码中，或者与代码交织在一起，这样文档就在相关部分旁边，或者在开头，中间或者结尾处作为一个大块
Pod可以轻松地转换为其他几种格式，例如LaTeX，Postscript，HTML等，以及Perl附带的翻译器（pod2latex，pod2ps，pod2html）。我甚至有一个转到InDesign的pod转换器。使用Pod::Simple编写自己的Pod翻译器非常简单，因此如果您没有找到您喜欢的最终表单的翻译器，请自行制作。
您还可以使用多种工具添加到测试套件中以检查Pod。 Test::Pod模块检查格式错误，Test::Pod::Coverage模块检查您是否记录了每个子例程，依此类推。您也可能对我的Perl documentation documentation感兴趣。
答案 1 :(得分：25)
我绝对推荐POD。
POD也可以与代码一起使用，但我更喜欢在__END__之后放入程序的底部（正如Damian Conway在Perl Best Practices中所推荐的那样）。
看看POD::Server＆amp; POD::Webserver，为您的所有POD提供网络前端。
答案 2 :(得分：20)
这就是Mozilla如何记录他们的Perl。
答案 3 :(得分：10)
不要过度翻转，但记录Perl代码的最佳方式与使用任何其他语言记录代码的方式相同。
对于特定工具，我使用标准内联注释的混合，用于较大块文档的pod，其中类似于 man 的格式是合适的，而TeX作为需要的文档的最终后备更自由形式。 （并且，本着“与任何其他语言相同”的精神，是的，我也使用pod来记录非Perl代码。）
答案 4 :(得分：6)
您使用哪个模块转换pod 到HTML？
查看Pod::ProjectDocs - 您将获得一个简单的命令行实用程序，它将Perl项目中的所有POD转换为一组HTML页面，其外观与您在search.cpan.org上看到的一样。< / p>
答案 5 :(得分：3)
您可能还想查看Damian Conway的Perl Best Practices。我使用了一些提示来清理我继承的一个小的Perl代码库。
答案 6 :(得分：3)
没有人提到Smart::Comments？它并不总是你想要的，但如果你需要更多的评论能力，那就太好了。
答案 7 :(得分：2)
单独的用户文档和编码器文档。也许将用户文档（tuts，faq，reference）放在那里的目录（/ doc）和编码器中与代码相同。不幸的是，它是由修道院预期的，在模块本身有概述。你可以在结束之后做好POD。您可以在评论中添加鬃毛编码文档。其他的东西，如编码风格或如何贡献放在代码库内的单独的.pod文件（root目录？）