TypeScriptのドキュメントが一瞬で作れるんだ、そうTypeDocならね - Qiita仕事でTypeScriptを書きながら「あ〜、真面目にドキュメント作るって面倒くさいよな〜」とか考えていたのですが、 そんな時に便利な素敵ツールTypeDocなるものがあったので使ってみたらとても捗りました。 TypeDocって何? TypeScriptのソースを解析してドキュメントを自動で作ってくれるツールです。まあ、jsdocのTypeScript版ですね。 jsdocより便利な点としては、アノテーションを書く必要がほぼありません。型情報とか全部ソースに書いてるんで。 jsdocのために @param {number} とか@classとかコメントで書くのダルいですよね。 人類はツールのためにコメントを書く責務から解放されつつあるのです。 使ってみた インストール TypeDocはnpmでインストールします。 npm install typedoc --save 個人的にグローバルイン
