OCaml için, komut satırından işlev veya kütüphane belgelerine hızlı bir şekilde erişmek için bir araç var mı?

Question

On yıllar önce DOS'ta DJGPP kullanmaya başladığımda, info'u kullanabilmeyi çok sevmiştim. Perl'de programladığımda, belgeleri almak için sadece perldoc -f map veya perldoc List::Util yazabilirim.

Ayrıntıları ezmemek için bana yardımcı olan başka araç örnekleri de var, ancak bunlar benim favorilerimden ikisi.

Son birkaç aydır, mükemmel Real World OCaml'u takiben OCaml üzerinde yavaş yavaş çalışıyorum.

İyi bir ilerleme kaydediyorum, ancak işlevler ve kitaplıklar hakkında hızlı bir şekilde bilgi gösterebilen bir aracın yararını çok özlüyorum. Örneğin, şu anda, Core.Std’da ne olduğunu bilmek istiyorsam, bir web sayfasına bakmam gerekiyor. Bu sayfadaki belgelerin yıldız olmadığını biliyorum, ama en azından, kitabımdan yazmak yerine kendi örneklerimi oluşturmaya çalıştığımda neyin yararlı olduğunu bilmek.

OCaml için perldoc benzeri bir araç var mı?

Değilse, komut satırından, belirli bir kitaplıkta yalnızca adını bilenleri nasıl keşfedebilirim? Yerleşik bir bilgisayarda nasıl hızlıca belge alabilirim? Katıştırılmış yorumlardan belgeler oluşturuyor gibi görünüyor. opam tarafından yüklenenlere dayanarak bir belge ağacını nasıl oluşturabilirim ve standart * nix araçları tarafından bulunsun mu?

Temelde biraz kayıp, ve bir el feneri ;-)

Answer 1

ocp-index yoktur arayan, ama sadece türünü sağlayan düşünüyorum. Bu bir komut satırı aracıdır ve Emacs ve Vim'e de entegre edilebilir. İşte daha kapsamlı bir araç derlenmiş dosyaları içinde tam dokümantasyon bilgilerini koruyacaktır derleyici'nın yeni özelliklerini kullanarak gerektirecektir

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

bir örnektir. Ayrıca, genellikle doc ile ilgili araçlara yardımcı olması gereken opam-doc aracının yeniden yazılması da olacaktır.