2014-07-18 50 views
5

當我幾十年前在DOS中開始使用DJGPP時,我喜歡能夠使用info。當我使用Perl編程時,只需鍵入perldoc -f mapperldoc List::Util即可獲取文檔。對於OCaml,是否有一種工具可以從命令行快速訪問函數或庫文檔?

還有其他工具幫助我避免記憶細節的例子,但這些是我最喜歡的兩個。

在過去的幾個月裏,我一直在OCaml上繼續工作,繼Real World OCaml

我正在取得很好的進展,但我非常遺憾能夠快速向我展示有關函數和庫的信息的工具的好處。例如,現在,如果我想知道Core.Std中的內容,我需要查看一個網頁。我知道該頁面上的文檔不是很好,但至少知道什麼地方是非常有用的,當我嘗試構建自己的示例時,而不是從書中輸入它們。

有沒有類似於OCaml的perldoc的工具?

如果沒有,我怎麼能從命令行發現什麼在給定的圖書館知道它的名字?我如何快速獲取內置文檔?

ocamldoc似乎從嵌入的評論生成文檔。如何根據opam安裝的內容生成文檔樹,並通過標準* nix工具找到它?

我基本上有點失落,並尋找一個手電筒;-)

+1

我認爲應該可以用'ocamldoc'生成信息文檔。至少它可以生成手冊頁(在debian'man list'中給出了與模塊'List'的html api doc相同的內容)。 – didierc

回答

4

ocp-index,但我認爲它僅提供了類型。它是一個命令行工具,也可以集成到Emacs和Vim中。下面是一個例子

$ ocp-index print -F Core.Std List.fold Core.Std.List.fold val 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

一個更全面的工具,將需要使用編譯器的新功能,將保留編譯的文件中完整的文檔信息。還將完全重寫opam-doc工具,該工具通常應該有助於與文檔相關的工具。

+0

你知道這是否已經完成嗎? – dfeuer

+1

就在昨天[報道](https://opam.ocaml.org/blog/codoc-0-2-0-released/),工作正在進行。 –

相關問題