Clojureドキュメントツールの最先端[閉鎖

StackOverflow https://stackoverflow.com/questions/5334525

質問

昨年かそこらで、ClojureディスカッションリストやClojureコードを文書化するためのツールに関する他の場所でさまざまな発表を見てきました。これらは、マージンリアのようなフルリテラシープログラミングシステムや、本「Clojure in Small Piece」（またはEmacs Org-Mode）を作成するために使用されているツールから、AutoDocのような従来のJavadocスタイルのソリューション、Javadoc自体にまで及びます。伝えられるところによると、Clojureで使用できます。 Googleの検索では、他のさまざまなものがあります。おそらく、より多くの注目に値するいくつかのものであり、確かにドキュメントを生成するための個人的なユーティリティであるものもあります。私の質問は、最良のドキュメントツールは何ですか？また、それらを使用した経験に基づいて、それらの比較の長所と短所は何ですか？私はこれまでドキュメントツールを使用しておらず、1つ以上の実験に興味があります。

役に立ちましたか？

解決

私は本当に好きです マリガリア 読み書きのできるプログラミングアプローチのようなものを取りたい場合。 Marginaliaはソースコードを横断し、非常に明確なテキストのコードの横にコメントを設定したHTMLフォーマットバージョンを作成します。コメントをフォーマットして、非常に読みやすい最終文書を作成できます。私がしばらく前に書いたソースコードをレビューするとき、私はマージンリアが本当に役立つと思います。 これが、マージンソース自体から作られた例です.

これは、ファイルを記述し、ソースコードが生成される元のリテラシープログラミングワークフローとは異なることに注意してください。 Marginaliaを使用すると、通常のソースコードファイルを書き込みます。それが引き出されたのはドキュメントです。出力は、識字プログラミングに期待されるかもしれないものに似ていますが、このようにして、特別な識字プログラミングサポートなしで、エディターで強調表示される構文を期待できます。

それはレインニンゲンと相互運用します、そして私はケーキを信じていますが、私はそれを自分で試していません。

他のヒント

autodoc 開始するのが簡単な場所であり、Clojureが 芯 とclojure 貢献 生産。

使いやすい メイベン. 。 LeiningenまたはCakeにプラグインが存在するかどうかはわかりません。

コドックス Clojureのより最近のドキュメントジェネレーターです。

あなたが完全に読み書きをしたいなら、あなたは与えるべきです org-babel-clojure 見て。 Org-Bableは、EMACS ORG-MODEの識字プログラミング拡張機能です。

nreplを使用する場合は、次のものを.emacsに追加する必要があります。

(defun org-babel-execute:clojure (body params)
  "Execute a block of Clojure code with Babel."
  (let ((result-plist (nrepl-send-string-sync (org-babel-expand-body:clojure body params) nrepl-buffer-ns))
        (result-type  (cdr (assoc :result-type params))))
    (org-babel-script-escape
     (cond ((eq result-type 'value)  (plist-get result-plist :value))
           ((eq result-type 'output) (plist-get result-plist :value))
            (t                        (message "Unknown :results type!"))))))
ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top