Ruby OptionParser 解析的文檔在哪里？ 方法？

Question

我一直無法找到任何要parse! ，這是 Ruby 標准發行版中OptionParser class 的一個非常常用的實例方法。

我看過parse! 在OptionParse class 文檔頂部的示例中使用。 但是，我正在尋找特定於此方法的文檔，即描述該方法的確切作用的文檔。 例如，文檔應該提供一個線索，說明為什么方法名稱以 bang 結尾（可能這個方法從 ARGV 中刪除了選項）。 它還可以描述我是否應該期望從parse! （解析的選項數量？）。

我已經嘗試閱讀OptionParse class 以及 class 頂部列出的所有子類的 官方文檔。 我還查閱了相關部分Programming Ruby （“鎬書”）。

我不是在問什么parse! 做; 通過閱讀其他 StackOverlow 線程，我對它有一個不錯的（如果不完美的話）感覺。 我希望提高理解 Ruby 文檔的能力。 我更習慣於 Perl/CPAN 文檔。 當我在處理Ruby文檔時，即使是標准的分發模塊，我也感到很失落。 就好像有人刪除或重新定位了關鍵信息。 有時我遇到一個我認為關鍵方法的文檔所在的位置，然后發現我只能簡單地檢查所述方法的源代碼。 我想知道也許我只是不習慣在 Ruby 中如何組織信息。 也許這對我來說是一個很好的教訓。

Answer 1

我的大部分文檔都使用Rubydoc.info 。 OptParse的文檔非常清楚地解釋了parse ，我認為：

在設置環境變量 POSIXLY_CORRECT 時按順序解析命令行 arguments argv，否則在排列模式下解析。

如果您檢查該方法的源鏈接，您會看到它是使用parse! ：

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

看着parse! 會告訴你更多。

關於丟失或刪除的信息：大多數 Ruby 文檔是由 RDoc 或 YARD 根據源代碼中的內容生成的，因此，缺少信息通常是代碼作者的錯。

有些人太忙而無法正確記錄，要么完全忽略它，要么不知道要記錄什么。 作為代碼的用戶，我們可以通過向實現更好文檔的源提交更改來提供幫助。 當我發現一些令人困惑或錯誤的地方時，我在不同的項目上做過很多次。