タスクランナーと組み合わせて gulpとGruntのプラグインが公開されている。 gulp-typedoc grunt-typedoc コメントの書き方 JavaDoc形式。YUIDoc形式のように、型情報を{String}のような表記で書く必要は無く.tsのソースを解析して出してくれる。 整形して解析してくれるタグは@paramと@return(s)の2つだけ。ただしそれ以外のタグを書いてあってもそれっぽく表示してくれるので問題ない。 コメント中にはHTMLやMarkdown形式が使える。 各種コマンドラインオプション 公式サイトで説明されていないものも結構ある。 型定義ファイルをドキュメント化する --includeDeclarationsオプションをつける。 型定義ファイルしか提供されてない場合でもそこからドキュメント化できる。下手に作られたドキュメントより見やすい。 ファイルでまと
![TypeDoc入門 - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/436a30951ae580e7b9f036812a91d1485b6eeade/height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-9f5428127621718a910c8b63951390ad.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTkxNiZoPTMzNiZ0eHQ9VHlwZURvYyVFNSU4NSVBNSVFOSU5NiU4MCZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTU2JnR4dC1jbGlwPWVsbGlwc2lzJnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9MWMxNGJhYjlkNGE0MTI2MTllNzQyZTFjNjE1NDUzMmM%26mark-x%3D142%26mark-y%3D112%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTYxNiZ0eHQ9JTQwQ29ucXVlc3RBcnJvdyZ0eHQtY29sb3I9JTIzMjEyMTIxJnR4dC1mb250PUhpcmFnaW5vJTIwU2FucyUyMFc2JnR4dC1zaXplPTM2JnR4dC1hbGlnbj1sZWZ0JTJDdG9wJnM9ZTkyNmMyOWY3MWEyMGIzOWQyZWRkNWE0ZWEwZGE4Mjg%26blend-x%3D142%26blend-y%3D491%26blend-mode%3Dnormal%26s%3D26d6d7113e40b60b13d7ffbc899a3bd7)