doccoを使ってみたよ
doccoというnode.js / CoffeeScript製ドキュメントジェネレータをご存知でしょうか。
以前から使ってみたかったdoccoですが、Pygmentsをeasy_installで直にインストールしたくなくて
躊躇しておりました。が、pythonbrewをインストールしてみたよ - 四角革命前夜で直にインストールせずにすむ環境を作ったのでインストールしてみました。
Ruby版のRoccoでもいいかな、と思ったのですが、コードを見てみたらサーバにコードを投げてるようで……
趣味のコードならいいかもですが、社外秘!なんてコードにはちょっと使い難いですねー。
どうせそんなコードには使わないのですけど。
あ、以下のメモはnvmでnode.jsがインストール済みになっていることが前提です。
環境:MacOS 10.7.2
Python環境の適用
$ pybrew use 2.7.2 $ pybrew venv use default $ which pygmentize /Users/sasaplus1/.pythonbrew/pythons/Python-2.7.2/bin/pygmentize
ここまではpythonbrew環境を整えたときの復習というか。
node.js環境の適用
v0.6.6がインストールされていたのでそれを使います。
npmの設定などはsasaplus1 / dotfiles / source / — Bitbucketのあたり(.bashrc.linux, .npmrc)を見ていただければと……!
$ nvm use v0.6.6
$ npm install -g coffee-script docco
これでインストール終了。はやいなー。
使ってみる
$ vi aaa.js
// すごいメソッドです function sugoi() { return 'sugoi'; }
$ docco aaa.js
docco: aaa.js -> docs/aaa.html
出力された!
スクリーンショット
おおおー!いいかも!
本当ならJsDocToolkitとかでちゃんとしたコメントを書くと一番いいんだろうけど、
デザイナーさんとかと一緒に(JavaScript書くデザイナーさんって多いのかしら)なら、
無いよりはマシ、と思って使うのがいいのかも。