问题标签 [perl-pod]

有什么建议可以记录我的 Perl 代码吗？您使用什么以及可以使用哪些工具来帮助我？

您使用哪个模块将 pod 转换为 html？

我有一些看起来像的 POD

该pod2html命令将其变为

问题是<a href="#item_close"></a>。我假设这样做是有帮助的（在通常情况下=item func()是函数定义的开始），但在我的情况下它是不合适的（这是一条警告消息）。

我已经尝试（没有成功）以下使 pod2html 不=item open()被视为函数定义：

最后两个不打印“（”。我是否错误地使用了 E<>？这是 pod2html 中的错误（我在 OS X 上使用 Perl 5.8.8）吗？

基于一个思想布赖恩的回答引发我尝试了另一个实验：

这应该导致<code>close<) on unopened filehandle %s</code>，但它却产生<code>close) on unopened filehandle %s</code>了。所以它看起来pod2html不喜欢数字实体。

我想为我自己的自定义命令创建一个 POD，并使用 pod2usage() 函数显示它的语法。

谁能给我一个简单的例子吗？

问候， 阿南丹

The L<name> formatting code allows you to set the display text for the link if you're linking to other POD, as in L<Display Text|link_dest>, but this isn't allowed for L<scheme:...> links, such as

How do I specify a display text for such links? Alternatively, how do I manually write such a link without the angle brackets being HTML entitized by pod2html?

我正在寻找的是一种良好的屏幕 POD 阅读体验。

多年来，我一直使用perldoc或man运行在xterm屏幕上阅读 Perl 文档，以及围绕它构建的小型自定义程序Pod::LaTeX来打印它。印刷版很好：脚本做得很好。然而，屏幕阅读是痛苦的：

• 您可以搜索，但祝您好运，例如，中的as部分DBIx::Class::ResultSet。Less 对文档的结构一无所知，搜索常见的英文单词毫无意义。
• 我害怕每次文件告诉我see section so-and-so。伟大的。现在我必须找到它。然后回到我原来的位置不会是微不足道的（尽管这可能是我不那么无知的表现）
• 见文件某某更糟。!perldoc foo可以，但是很难在两个文档之间切换。您可以通过少挂起并perldoc从 shell 运行来解决这个问题，但那是更多的击键，我很懒惰。
• 格式化还有很多不足之处。

我希望能够单击目录，然后转到该部分。我希望能够单击“查看其他”并去那里。等等。到目前为止，我知道两种可能性：

• search.cpan.org，例如DBIx::Class::ResultSet。需要 Internet 连接，但这通常不是问题。
• Podbrowser. 刚开始尝试这个，看起来很不错。

我正在运行 Lenny 和 Squeeze 的 Debian GNU/Linux。但请为所有平台推荐程序，以使其尽可能有用。

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

为什么不pod2usage呢？

这无助于我在字符串中但在 STDOUT/file 中获取输出。我强调“以字符串形式获取它”这一点，因为如果长度超过屏幕长度，我想在“页面”中显示 POD。pod2usage不会在页面中打印它们:(

有人可以告诉我为此目的使用哪个模块吗？

我能够从 Safari Books Online 中找到一个提供模板的页面，但是我从未写过 POD 评论，我不确定它有多好，或者它是否缺少任何可能被视为包含约定的内容。

为 Perl 脚本编写 POD 注释时要遵循哪些约定？有没有像Sun 的 Javadoc Conventions一样的东西，但对于 POD 注释？

Pod 是否有易于使用的“所见即所得”编辑器？

我还没有习惯 Pod 语法，所以可以选择编写 Pod 并立即查看输出的样子会很有帮助。理想情况下，这个编辑器应该有某种“代码完成”来帮助正确的语法。

有这样的编辑吗？

是否有可用的工具可以在目录树中生成 perl 模块或脚本的 HTML 摘要列表？

给定

我想看到类似的东西

有没有办法使用 POD 编写多语言文档？如果不是，我应该写什么（我已经有英文的 POD 文档，所以我想转换它然后翻译）？