TypeScriptのAPIドキュメントをyuidocjsで自動生成 - 成らぬは人の為さぬなりけり
現在、仕事でTypeScriptを使っていますが、 APIドキュメントが欲しくなってきて、 JavaDocとか、RDocとか、ScalaDocとか、みたいに 自動生成させたいなぁと思い、いろいろ試してみました。 試したツール jsdoc (npm) JsDoc Toolkit jsduck (gem) yuidocjs (npm) 試した結果 jsdoc : module以下のクラスのdocが生成できなかった JsDoc Toolkit : jsdocと同じ jsduck : docに定義されているタグが足りないとエラーになる yuidocjs : module以下のクラスもdoc生成できた と、いう訳で、yuidocjsを使ってドキュメント生成することにしました。 以下、環境構築手順と使い方についてメモしたいと思います。 環境 MacOSX 10.8.3 npm 1.2.14 types
Documenting JavaScript With YUIDoc | Envato Tuts+
Documenting your code is somewhat like testing; we all know we should do it, we’re not really sure how, and most folks, if we're honest, simply don’t, but those who do are huge proponents of it. This tutorial will get you up to speed on one of the best ways to tackle it: YUIDoc. What is YUIDoc? YUIDoc will generate API documentation based on comments that you write. YUIDoc is a NodeJS app that wil
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
