有没有办法获得＆＃34; docstring＆＃34;功能？

Question

要获得功能/模块的足迹， 我能做到：

module type S = module type of Stack;;

如何获取某些功能的描述/文档字符串？

Answer 1

您可以使用ocp-browser，它提供了一个命令行界面来浏览您已安装的所有软件包。

它有一个搜索功能，按空格键，您可以看到与功能相关的文档。

以下是BoxView模块的示例。

更新：2017年6月22日

几天前，在OPAM上发布了一个名为ocp-index-top的软件包，允许您查看OCaml顶级文档。

Answer 2

我认为不可能这样做。实际上，签名应该让您很好地了解函数应该做什么，如果您不确定是否必须阅读manual中的描述。

作为旁注，有一种更容易的方式来查看任何东西的签名（函数，模块，异常......）

# #show ident;;

正如here所写，

  

在启动时，顶层系统包含标准库中所有模块的实现。

我将其理解为only the .cm* files are loaded，在这些文件中，您将找不到记录这些功能的注释。那么，我几乎可以肯定你无法从顶层读取函数的文档。

但是，实际上，我认为你习惯于从名称和签名中了解函数的用途