记录Perl代码的最好方式是什么?

任何建议,如何我可以记录我的Perl代码?你使用什么和什么工具可以帮助我?

你使用哪个模块将pod转换为html?

解决方法

看看几乎任何Perl模块,你会看到 Plain Old Documentation (POD)格式。在 CPAN Search,当看一个模块,你可以选择查看原始源,所以这是一种方法,你可以看看原始的pod,但你也可以使用 perldoc从命令行。 -m开关显示文件
perldoc -m Foo::Bar

或者,如果要查找该文件,以便您可以在自己喜爱的编辑器中查看该文件,请使用-l开关来查找它:

perldoc -l Foo::Bar

一旦你开始记录你的程序,你把Pod放在文件中的代码,或者与代码交织在一起,所以文档在相关部分旁边,或者在开始,中间或结束作为一个大块。

Pod可以很容易地转换为几种其他格式,如LaTeX,Postscript,HTML等等与Perl的翻译(pod2latex,pod2ps,pod2html)。我甚至有一个pod转换器去InDesign。使用Pod::Simple编写自己的Pod翻译器很容易,所以如果你没有找到翻译到你最喜欢的最终形式,只是自己做。

还有几种工具可以添加到测试套件中以检查您的Pod。 Test::Pod模块检查格式错误Test::Pod::Coverage模块检查您已经记录了每个子程序,等等。你也可能对我的Perl documentation documentation感兴趣。

相关文章

忍不住在 PerlChina 邮件列表中盘点了一下 Perl 里的 Web 应用框架(巧的是 PerlBuzz 最近也有一篇相关...
bless有两个参数:对象的引用、类的名称。 类的名称是一个字符串,代表了类的类型信息,这是理解bless的...
gb2312转Utf的方法: use Encode; my $str = "中文"; $str_cnsoftware = encode("utf-8...
  perl 计算硬盘利用率, 以%来查看硬盘资源是否存在IO消耗cpu资源情况; 部份代码参考了iostat源码;...
1 简单变量 Perl 的 Hello World 是怎么写的呢?请看下面的程序: #!/usr/bin/perl print "Hello W...
本文介绍Perl的Perl的简单语法,包括基本输入输出、分支循环控制结构、函数、常用系统调用和文件操作,...