CODEWITHSUNDEEP
clojuredocumentationdocstring
mikera
mikera

Reputation: 106351

Clojure docstring for libraries/namespaces

How to add docstrings and/or comments to Clojure libaries/namespaces as a whole, i.e. not just to specific functions within the namespace?

I've noticed that the clojure source uses (comment ...) in some places to do this (example), is that recommended?

Upvotes: 31

Views: 4613

Answers (2)

Gert
Gert

Reputation: 3859

You can add it to the ns declaration:

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

The example you link to does that too - so not sure if this is what you mean? But I think it's the most "standard" - it will get picked up by documentation systems such as Codox and Autodoc.

Upvotes: 20

kotarak
kotarak

Reputation: 17299

You can add a docstring to any namespace in the ns form.

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

Upvotes: 50

Related Questions