Clojure Book › ドキュメント化

TL;DR

• Clojure では、関数のドキュメントを関数名と引数の間に Markdown 形式で書く。書いたドキュメントは doc 関数や IDE で確かめられる。

内容

Clojure は関数（この言語の**第一級市民**）をドキュメント化する方法を提供している。

(defn sum
  "Adds two numbers passed as arguments.
   The arguments hould be numbers.
 
   **Usage**
   ```clojure
   (sum 4 5) ;; returns 9
   ```
  "
  [a b]
  {:pre [(number? a) (number? b)]
   :post [(number? %)]}
  (+ a b))

関数のドキュメントは関数名と引数の間に書く。ドキュメントは Markdown 形式で書く。

書いたドキュメントは doc 関数や IDE で確かめられる。

(doc sum)
;; #'user/sum-------------------------
;; user/sum
;; ([a b])
;;   Adds two numbers passed as arguments.
;;    The arguments hould be numbers.
;;
;;    **Usage**
;;    ```clojure
;;    (sum 4 5) ;; returns 9
;;    ```

キーワード

• Clojure
• 第一級市民