28

名前空間内の特定の関数だけでなく、Clojure ライブラリ/名前空間全体にドキュメント文字列やコメントを追加するにはどうすればよいですか?

これを行うために clojure ソース(comment ...)がいくつかの場所で使用されていることに気付きました ( example )。それは推奨されますか?

4

2 に答える 2

45

フォーム内の任意の名前空間に docstring を追加できますns。

(ns my.name.space
  "Very cool namespace doing this and that."
  (:require other.cool.stuff))
于 2012-07-23T11:08:36.297 に答える
19

ns宣言に追加できます。

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

あなたがリンクしている例もそれを行います - これがあなたの言いたいことかどうかわかりませんか? しかし、私はそれが最も「標準的」だと思います - CodoxやAutodocなどのドキュメンテーション システムによって取り上げられるでしょう。

于 2012-07-23T11:08:18.593 に答える