undefined

bokuweb.me

CoffeeScriptにも対応したドキュメントジェネレータ「docco」を使ってみた!


業務ではCのソースをdoxygenを使ってみたドキュメント化していたんですが、CoffeeScriptに対応したものはあるのかな?っと調べたところ「docco」というツールがシンプルで良さ気だったので使ってみました。

Docco

インストール

  1. npmでインストールします
>sudo npm install -g docco

これで終了!

使い方

  1. 以下のようにソースを指定します
>docco hoge.coffee

簡単!

どんなドキュメントに?

たとえばこれは

class hoge
  # hogeclass
  # ドキュメントジェネレータ「docco」のテストだよ
  fugafuga : ()->
    # fugafuga
    console.log "fugafuga"

こんなhtmlファイルになります。

f:id:bokuweb:20141218215654p:plain

よいですね。doxygenのイメージとはちょっと違いコメントを綺麗に分離してくれるって感じですね。