Как добавить строки документации и/или комментарии к библиотекам/пространствам имен Clojure в целом, то есть не только к конкретным функциям в пространстве имен?
Я заметил, что исходный код clojure использует для этого (comment ...) в некоторых местах (пример), это рекомендуется?
Вы можете добавить его в объявление ns:
(ns ^{:author "mikera"
:doc "My awesome library"}
foo.bar.core)
Пример, на который вы ссылаетесь, тоже делает это, поэтому не уверен, что вы имеете в виду это? Но я думаю, что это самый «стандартный» — его подхватят системы документации, такие как Codox и Autodoc.
ns определено для получения docstring в качестве необязательного второго аргумента. Этот ответ эквивалентен ответу Котарака.
- person John Wiseman; 25.02.2014
Вы можете добавить строку документации в любое пространство имен в форме ns.
(ns my.name.space
"Very cool namespace doing this and that."
(:require other.cool.stuff))
lein clean.
- person Gra; 31.01.2016
