如何获取字符串中的 Perl POD 并将其打印在页面中？

Question

我有一个 POD 文档。现在，我想将该 POD 转换为已解析的部分，例如用法/描述，并将其放入字符串中。

为什么不使用pod2usage？

这并不能帮助我获取字符串中的输出，而是 STDOUT/文件中的输出。我强调“将其放入字符串”，因为如果长度超过屏幕长度，我想在“页面”中显示 POD。 pod2usage 不会在页面中打印它们:(

有人能告诉我吗我应该使用哪个模块来实现此目的？

Answer 1

Pod::Usage，在 pod2usage 手册页底部引用。

Answer 2

来自 Pod::Parser 文档：

或者，IO::String 对象也被接受作为输出文件句柄。

所以这是完全合法的：

#!/usr/bin/perl
use strict;
use IO::String;
use Pod::Text;
my $buffer;
my $io = IO::String->new($buffer);
my $parser= Pod::Text->new (sentence => 0, width => 78);
$parser->parse_from_file('/usr/share/perl5/Net/Jabber.pm',$io);
print $buffer;

另一方面，请记住，您可以使用反引号捕获任何命令的输出，例如

$text = `/usr/bin/pod2usage /usr/share/perl5/Net/Jabber.pm`;

或 qx{} 为了清楚起见：

$text = qx{/usr/bin/pod2usage /usr/share/perl5/Net/Jabber.pm};

Answer 3

您不必自己完成所有 Pod 解析；大部分工作已经通过 Pod::Simple 完成。您可以编写一个简短的子类来执行您需要的任何操作。我在 Mastering Perl 中有一个章节详细介绍了这些细节，但你也可以看看我的 Pod::Perldoc::TOC 模块查看一个简短的示例。

基本上，您处理 =head1 元素，但跳过不是 SYNOPSIS 的元素。一旦遇到正确的=head1，设置一个标志并处理该部分，直到遇到另一个=head1，此时停止解析。您可以在 =head1 之间执行任何操作，包括附加到变量。