有没有办法获得函数的 "docstring" ?
Is there a way to get a "docstring" of a function?
要获取 function/module 的足迹,
我能做到:
module type S = module type of Stack;;
我应该怎么做才能获得某些功能的description/docstring?
我认为这是不可能的。实际上,签名应该让您很好地了解函数应该做什么,如果您不确定,则必须阅读 manual.
中的描述。
附带说明一下,有一种更简单的方法可以查看任何内容(函数、模块、异常...)的签名,即
# #show ident;;
写成 here、
At start-up, the toplevel system contains implementations for all the modules in the the standard library.
我将其理解为 only the .cm* files are loaded
,并且在这些文件中您找不到记录函数的注释。那么,我几乎可以肯定您无法从顶层阅读函数的文档。
但是,实际上,我认为您已经习惯了从函数的名称和签名来理解函数的用途
您可以使用 ocp-browser
,它提供了一个命令行界面来浏览您已安装的所有包。
它具有搜索功能,通过按 space 栏,您可以查看与某个功能关联的文档。
下面是 Stack
模块的示例。
更新:2017 年 6 月 22 日
几天前,OPAM上发布了一个名为ocp-index-top
的包,可以让你看到OCaml顶层里面的文档。
要获取 function/module 的足迹, 我能做到:
module type S = module type of Stack;;
我应该怎么做才能获得某些功能的description/docstring?
我认为这是不可能的。实际上,签名应该让您很好地了解函数应该做什么,如果您不确定,则必须阅读 manual.
中的描述。附带说明一下,有一种更简单的方法可以查看任何内容(函数、模块、异常...)的签名,即
# #show ident;;
写成 here、
At start-up, the toplevel system contains implementations for all the modules in the the standard library.
我将其理解为 only the .cm* files are loaded
,并且在这些文件中您找不到记录函数的注释。那么,我几乎可以肯定您无法从顶层阅读函数的文档。
但是,实际上,我认为您已经习惯了从函数的名称和签名来理解函数的用途
您可以使用 ocp-browser
,它提供了一个命令行界面来浏览您已安装的所有包。
它具有搜索功能,通过按 space 栏,您可以查看与某个功能关联的文档。
下面是 Stack
模块的示例。
更新:2017 年 6 月 22 日
几天前,OPAM上发布了一个名为ocp-index-top
的包,可以让你看到OCaml顶层里面的文档。