update.仕事でTypeScriptを書きながら「あ〜、真面目にドキュメント作るって面倒くさいよな〜」とか考えていたのですが、そんな時に便利な素敵ツールTypeDocなるものがあったので使ってみたらとても捗りました。TypeDocって何?TypeScriptのソースを解析してドキュメントを自動で作ってくれるツールです。jsdocのTypeScript版ですね。jsdocより便利な点としては、アノテーションを書く必要がほぼありません。型情報とか全部ソースに書いてるんで。@classとかコメントで書くのダルいですよね。人類はツールのためにコメントを書く責務から解放されつつあるのです。使ってみたインストールTypeDocはnpmでインストールします。--save個人的にグローバルインストールが嫌なので、ローカルインストールです。コマンドラインから使えるようにpackage.jsonのscriptsに追記しておきましょう。}}scripts.typedocsの所に引数とかオプションとかついているのは、ソースを保存しているディレクトリやドキュメントの出力先です。さりげなくgulpがいるのは、後でgulpから起動する方法も紹介するからです。TypeScriptを用意する今回ご用意するのはこちら。}}適当感あふれるモジュール。それではこれらのドキュメントを作ってみます。ドキュメント生成あとはtypedocを起動するだけと言いたいところですが、内部的に一度TypeScriptをコンパイルするのでtsconfig.jsonを忘れずに用意しときましょう。今回はTypeScriptの公式にあったサンプルをほぼコピペしたものを使います。typedocとコマンドを打てば、docs以下に生成されます。見た目もスッキリしてるし、implementsとかextendsとかはちゃんとリンクも貼ってくれます。path/to/typescript/project/ソースディレクトリとドキュメントの出力先は必須というわけですね。ドキュメントのタイトルを指定する。ヘッダに表示されます。README.mdのパスを指定します。デフォルトではプロジェクトルートのREADME.mdが読み込まれます。モジュールシステムを指定します。コンパイル後のecmascriptのバージョン。ソース解析の対象外の指定。ドキュメントの見た目を変えられるみたいです。gulpから起動する普通にコマンドから起動するのでほぼ事足りるので有り難みは薄い気がしますが、gulpからも使えます。--save決してグローバルには入れないのが俺のジャスティス。['typedoc']);コマンドライン引数と同様のパラメータをgulp-typedocの引数として与えます。typedocで出来上がり。upLoginユーザーは見つかりませんでした。