[JavaScript|TypeScript] TypeScriptでドキュメントを書くのにTYPE DOCが便利

2015/09/19

こんにちは。きんくまです。

タイトルだけで終わってしまうのですが、TypeScriptでドキュメント生成ツールをどうしようかと思いまして。

検索してみるとyuidocがよいとのことでまず試してみました。

1.TypeScriptからJavaScriptに変換
2.それをyuidocで出力

ということをしてみたのですが、生成後のjavaScriptにstaticプロパティのコメントがうまく残ってくれなくって、どうしようと思っていました、、。設定の問題なのかもしれない。

でも、少し検索してみたらTypeScriptから直接吐き出すツールが見つかりました。

>> TYPE DOC
typedoc_snapshot

yuidocだといろいろと書かないといけないのですが、TypeDocでは型情報を書かなくても自動で生成してくれたりして結構便利です。すごい。

privateもstaticも出力できて、かつ出力後に右上のチェックボックスで動的に表示を切り替えられます。継承したものとかprivateを見せなくしたりとか。

このデモのようにきれいな画面が出力されました。(実際にはTypeDocのAPIです)
typedoc_api_snapshot

日本語だとわかりやすいこちらの記事が見つかりました。

>> TypeDoc入門

ただ、そのままインストールすると現在はコンパイラーが1.6betaが使われていました。そのため、自分の場合は以前から進めているプロジェクト(古いコンパイラを使用)だと、エラーが出てしまい出力ができませんでした。ですので、githubで古いリリースバージョンを見つけてそれを入れることで無事出力できました。

参考)TypeDocの前のリリース版のページ
>> Releases · sebastian-lenz/typedoc

例)

npm install typedoc@0.2.2 -g

という感じです。TypeScirptはもともと型情報が書いてあるので、直接読み取ってもらえてよかったです。ではでは。

LINEで送る
Pocket

自作iPhoneアプリ 好評発売中!
フォルメモ - シンプルなフォルダつきメモ帳
ジッピー電卓 - 消費税や割引もサクサク計算!

ページトップへ戻る