Подтвердить что ты не робот

Clojure docstring для библиотек/пространств имен

Как добавить строки документации и/или комментарии к библиотекам/пространствам имен Clojure в целом, т.е. Не только к определенным функциям в пространстве имен?

Я заметил, что источник clojure использует (comment...) в некоторых местах для этого (пример), это рекомендуется?

4b9b3361

Ответ 1

Вы можете добавить его в объявление ns:

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

Пример, на который вы ссылаетесь, делает это тоже - поэтому не уверен, что это то, что вы имеете в виду? Но я думаю, что это самый "стандартный" - он будет подхвачен системами документации, такими как Codox и Autodoc.

Ответ 2

Вы можете добавить docstring в любое пространство имен в форме ns.

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