業務ではCのソースをdoxygenを使ってみたドキュメント化していたんですが、CoffeeScriptに対応したものはあるのかな?っと調べたところ「docco」というツールがシンプルで良さ気だったので使ってみました。
インストール
- npmでインストールします
>sudo npm install -g docco
これで終了!
使い方
- 以下のようにソースを指定します
>docco hoge.coffee
簡単!
どんなドキュメントに?
たとえばこれは
class hoge # hogeclass # ドキュメントジェネレータ「docco」のテストだよ fugafuga : ()-> # fugafuga console.log "fugafuga"
こんなhtmlファイルになります。
よいですね。doxygenのイメージとはちょっと違いコメントを綺麗に分離してくれるって感じですね。