Ruby OptionParser 解析的文档在哪里！方法？答案

【问题标题】：Where is the documentation for Ruby OptionParser's parse! method?Ruby OptionParser 解析的文档在哪里！方法？
【发布时间】：2011-08-14 20:33:38
【问题描述】：

我无法找到parse! 的任何文档，这是 Ruby 标准发行版中 OptionParser 类的一个非常常用的实例方法。

我已经看到parse! 在documentation for the OptionParse class 顶部的示例中使用。但是，我正在寻找特定于此方法的文档，即描述该方法的确切作用的文档。例如，文档应该提供一个线索，说明为什么方法名称以 bang 结尾（可能这个方法从 ARGV 中删除了选项）。它还可以描述我是否应该期望从parse! 返回任何有用的东西（解析的选项数量？）。

我已尝试阅读 official documentation 的 OptionParse 类以及该类顶部列出的所有子类。我还查阅了相关部分Programming Ruby（“镐书”）。

我不是问parse! 做了什么；通过阅读其他 StackOverlow 线程，我对它有一个不错的（如果不完美的话）感觉。 我希望提高理解 Ruby 文档的能力。我更习惯于 Perl/CPAN 文档。当我处理 Ruby 文档时，即使是标准的分发模块，我也感到非常迷茫。就好像有人删除或重新定位了关键信息。有时我遇到一个我认为关键方法的文档所在的位置，然后发现我只能简单地检查所述方法的源代码。我想知道我是否只是不习惯 Ruby 中的信息组织方式。也许这对我来说是一个很好的教训。

【问题讨论】：

你的问题不是很清楚。您想了解OptionParser.parse! 或如何理解 Ruby 文档吗？
我正在寻找 Ruby OptionParser 解析文档的 URL！方法。问题在标题中：“Ruby OptionParser 的 parse! 方法的文档在哪里？”出于某种原因，它不在 ruby-doc.org 上，但您提供的 rubydoc.info 链接确实包含更完整的方法列表，这非常有帮助。

标签： ruby optionparser

【解决方案1】：

我的大部分文档都使用Rubydoc.info。 OptParse 的文档非常清楚地解释了 parse 我认为：

在设置环境变量 POSIXLY_CORRECT 时按顺序解析命令行参数 argv，否则在排列模式下。

如果您查看该方法的源链接，您会看到它是使用 parse! 实现的：

def parse(*argv)
  argv = argv[0].dup if argv.size == 1 and Array === argv[0]
  parse!(argv)
end

看看parse!会告诉你更多。

关于丢失或删除的信息：大多数 Ruby 文档是由 RDoc 或 YARD 根据源代码中的内容生成的，因此，丢失信息通常是代码作者的错。

有些人太忙而无法正确记录，要么完全忽略它，要么不知道要记录什么。作为代码的用户，我们可以通过向实现更好文档的源提交更改来提供帮助。当我发现一些令人困惑或错误的地方时，我在不同的项目中做了很多次。

【讨论】：

我添加了解析方法文档的直接链接；您只链接到包含所有 OptParse 类及其方法的框架集的最顶部。我会继续接受这些更改的答案。直接网址是：rubydoc.info/stdlib/optparse/1.9.2/…