perl - Perl 有类似 Java/PHP Docs 的东西吗？

Question

Perl 有 Perl 文档生成器吗？Java Docs 或 PHP Documenter 之类的东西？

Answer 1

是的，它叫做perldoc

您只需在源代码中编写文档，就像使用 javadoc 一样。

简而言之，“=item”是一个项目符号，例如函数或参数“=over”下降一个标识级别，“=back”上升一个级别。在要切换回 perl 代码的地方使用“=cut”。

这是它的外观示例：

=item $b->add_module ( %options )

Initialize a module. A module is a repository or a branch of a repository.
Valid options are

=over

=item id

Id of this module

=item repo

Url of repository. Currently only subversion repositories are supported.

=back

=cut
sub add_module($%)
{

只需通过 perldoc 程序传递您的 perl 代码即可获得格式化的文档。

Answer 2

你的意思是perldoc？

另请参阅此相关的 Stack Overflow 问题：

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

Answer 3

为什么是。是的，它确实！翻译文档。

Answer 4

[仅适用于 googlers] 正如人们已经说过的那样，您使用 POD 制作文档（不是评论，评论是给维护者的，pod 是给用户文档的）。通常您在脚本或模块的开头和结尾以及每个方法之前添加您的POD，然后您可以perldoc your_module在控制台中使用，或者pod2html转换为html并在服务器中浏览，或者使用pdoc（有点旧但是当你想要一个 web doc navigator 和 web 中的代码链接时非常有用）。

还有一个关于格式化 pod 的新问题，您可能也感兴趣 perl-documentation-pod-browsers

还有这个how-can-i-generate-html-documentation-for-perl-code-comments

还有另一个人在谈论做一个 pod2html 并使用一个 css 文件来模仿 cpansearch 页面，但我现在找不到它。