関数の "docstring"を得る方法はありますか？

は、機能/モジュールのフットプリントを取得するには、は私が行うことができます。関数の "docstring"を得る方法はありますか？

module type S = module type of Stack;;

私はいくつかの機能の説明/ドキュメンテーション文字列を取得するにはどうすればよいですか？

出典

2017-06-16 Igor Chubin

utopで '＃のshow'コマンドは、あまりにも、便利です。答えが示すように、ドキュメントはデフォルトではutopで利用できません。 Clojureのような言語では、docstringは実際に関数とともに格納されています。関数は非常に低レベルのコードにコンパイルされるので、これはOCamlにとっては不自然なことになります。 RichouHunterの答えに加えて、utopのドキュメントストリングのような機能を可能にするパッケージはocp-index-topです：[https://github.com/reynir/ocp-index-top](https://github.com/） reynir/ocp-index-top）を参照してください。私はそれを試していない。 'odoc'や' ocamldoc'で独自のドキュメントページを作ることもできます。 – Mars

ocamlbrowser（別途提供されています）を使用して、標準ライブラリ（mliファイルにコメントがあります）のいくつかの機能に関するメモリをリフレッシュする必要があるときはいつでも、mliファイルを調べます。 – didierc

あなたがインストールされているすべてのパッケージを参照するには、コマンドラインインターフェイスを提供しocp-browserを、使用することができ、その名前とシグネチャから関数の目的を理解することに慣れると思います。

検索機能があり、スペースバーを押すと、機能に関連するドキュメントが表示されます。

ここにはStackモジュールの例があります。

更新日：2017年6月22日

数日前、ocp-index-topという名前のパッケージを使用すると、OCamlのトップレベルの内部のドキュメントを参照してくださいすることができ、OPAMに掲載されていました。

出典

2017-06-16 13:51:55 RichouHunter

私のパッケージが提案されているのを見るために冷静に！おそらく私はそのバグのいくつかを修正するべきでしょう:-) – ReyCharles

私はそうすることはできないと思います。実際には、シグネチャは、関数が何をすることになっているかについての良い洞察を与えるべきであり、あなたが確信が持てない場合はmanualの説明を読む必要があります。書かれたhereとして

# #show ident;;

ある

側の注意点として、何の署名を見て簡単な方法（関数、モジュール、例外が...）があります、

で起動時には、トップレベルシステムに標準ライブラリのすべてのモジュールの実装が含まれています。

私はonly the .cm* files are loadedと理解していますが、これらのファイルには機能を説明するコメントはありません。私は、あなたがトップレベルから関数のドキュメントを読むことができないことはほとんど確信しています。

はしかし、本当に、私はあなたが

出典

2017-06-16 09:36:35 Lhooq

はい、私はこれを知っていますが、署名に過ぎません。時にはあなたは本当にdocumentaionが必要です（しかし、とにかく助けと+1に感謝します） –

その後、マニュアルを参照する必要があります;-) – Lhooq

関数の "docstring"を得る方法はありますか？

答えて

関連する問題