=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($%)
{
4条答案
按热度按时间egmofgnx1#
是的,它被称为POD(以前称为:perldoc)
您只需在源代码中编写文档,就像使用javadoc一样。
简单地说,“=item”是项目符号项,例如例如,函数或参数“=over”下降一级标识,“=back”上升一级。在想切换回perl代码的地方使用“=cut”。
下面是一个例子,它可能看起来像什么:
只需通过perldoc程序传递您的perl代码就可以获得格式化的文档。
2mbi3lxu2#
为什么,是的。是的,是的!Perldoc。
nzk0hqpo3#
你是说perldoc?
另请参阅相关的Stack Overflow问题:
ergxz8rk4#
[just正如人们已经说过的,你用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页面,但我现在找不到了。