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

Question

Perl是否有Perl Docs生成器？像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 eflow相关问题：

• What’s the best way to document Perl code?

Answer 3

为什么，是的。是的，它确实！ Perldoc

Answer 4

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

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

和这一个how-can-i-generate-html-documentation-for-perl-code-comments

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