EclipseでのOCamlコードのドキュメント

Question

私はOcaIDE-Pluginと一緒にEclipseを使用して、私のocaml-projectを書いています。

私はいくつかのocaml関数を記述しました（コメント、戻り値、およびパラメータ）。

このリンクで説明したように、私は.mlの-ファイルの私の文書を作成しました

：ここ

http://caml.inria.fr/pub/docs/manual-ocaml/ocamldoc.htmlは一つの機能の例です。残念ながら

(** sorting tuples where first element is key *) 
let my_comp x y = (*Some code*) 

、私のコメントは表示されません。ファンクションの1つでF2キーを押すと、名前とファイルが表示されます。

mliファイルにコメントを書くとき、それは期待通りに機能しますが、外部からアクセスできない「プライベート」関数もドキュメント化したいと思っています。ドキュメンテーションのためだけに、外部からアクセスできない関数をmliで定義することはできますか？

私のドキュメンテーションを表示するにはどうすればよいですか？

Answer 1

まあ、あなたが言ったように、ドキュメントを表示したいが、モジュールから機能をエクスポートすることはできません。それは悲しいことですが、うまくいきません。

私はOcaIDEが不完全だと思うかもしれないと思うが、それは人の気にかわるようなものではない（私はOcaIDEで働いている人は一人も知らない）。あなたがオートコンプリートなどが好きな人は、emacsでプログラムを作ってmerlinをインストールしてみてください（見て、私はあなたのために完璧な投稿を見つけました：here）

外部からアクセスできないmliの関数を定義することの提案は、 mliファイルが作成される理由とは完全に反対しているため、可能であるとは思わないでください。 ;-)

私はあなたを助けることができたと思った。