ライブラリ/ネームスペースのClojureドキュメント

Clojureライブラリ/名前空間全体に、つまり名前空間内の特定の関数だけでなく、ドキュメントストリングやコメントを追加する方法は？ライブラリ/ネームスペースのClojureドキュメント

クロージャーソースがこれを行う場所（example）を(comment ...)であることに気付きましたが、これはお勧めですか？これはあなたが何を意味するかであればそれほどわからない - あなたがにリンクの例では、あまりにも行い

(ns ^{:author "mikera" 
     :doc "My awesome library"} 
    foo.bar.core)

：

出典

2012-07-23 mikera

あなたはns宣言に追加することができますか？しかし、私はそれが最も標準的だと思っています。CodoxとAutodocのような文書化システムによって取り上げられます。

出典

2012-07-23 11:08:18 Gert

(ns my.name.space "Very cool namespace doing this and that." (:require other.cool.stuff))

注 'こと（http://clojure.github.io/clojure/clojure.core-api.html#clojure.core/ns）任意の第二のようにドキュメント文字列を取ります引数。この答えは[kotarakの答え]（http://stackoverflow.com/a/11611325/122762）と同じです。 –

nsフォームの任意の名前空間にドキュメントストリングを追加できます。 ns`は、[定義]れる

出典

2012-07-23 11:08:36 kotarak

確かに。また、CodoxがHTMLファイルに表示されないようにするには、「lein clean」を試してください。 – Gra

codox https://github.com/weavejester/codoxへのリンク、ちょうどbtw –

ライブラリ/ネームスペースのClojureドキュメント

答えて

関連する問題