Haah Doccoy

http://r7kamura.github.com/mmd.js/docs/parser.html
https://github.com/r7kamura/mmd.js/blob/master/coffee/mmd/parser.coffee

CoffeeScriptで開発しているmmd.js にドキュメントを書こうと思って色々ツールを探した結果、Doccoが良かった。 書くコストが低く、ある程度フォーマットが統一され、 エディタとブラウザでそれぞれに適したフォーマットで読める、というものを探していた。 他にはJSDoc、YUIDoc等を見た。 Doccoは新しく覚えることが少ない点が良かった。 HTML形式で出力してくれる奴は、github-pagesとも相性が良い。 コードリーディングの時に過程を残しておく用途にも良いかもしれない。

$ npm install -g docco
$ docco **/*.coffee

コメントを書かないで良いくらい分かりやすいコードを書きましょうという話があるけど、
コメントを書かないで良いくらい分かりやすいコードを書けたことがないので精進したい。

広告を非表示にする