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

Phi*_*ord 10 perl documentation-generation

Perl有Perl Docs生成器吗?像Java Docs或PHP Documenter之类的东西?

ama*_*ion 13

是的,它被称为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($%)
{
Run Code Online (Sandbox Code Playgroud)

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

  • 我强烈建议不要在代码之间使用pod(隔行扫描),因为标记非常臃肿,只是用于混淆导航和代码一致性.编写自我记录代码,并将pod放在文档底部的"__END__"标记下面. (4认同)
  • 回应Evan Carroll - 这只是个人偏好 - 我通常更喜欢隔行扫描的pod,它可以让文档更新更容易,任何体面的编辑器都可以让你轻松查看代码和内容. (4认同)

Gor*_*don 7

你的意思是perldoc

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


Pau*_*han 7

为什么是.是的,它确实!Perldoc.