JSDocは、JavaScriptのソースコードにアノテーション(注釈)を追加するために使われるマークアップ言語である。JSDocをコメントの中に含めることで、プログラマーは自分が書いたコードのAPIを記述するドキュメントを追加することができる。JSDocをさまざまなツールで処理することで、HTMLやRich Text Formatなどの形式のアクセス可能なドキュメンテーションを自動生成することができる。JSDocは、Apache License 2.0の元にライセンスされている自由ソフトウェアである。
歴史
JavaScriptをドキュメントするためにJavadocに似た構文を使用した最初期の使用例は、1999にリリースされたNetscape/MozillaプロジェクトのRhinoである。これは、Javaで書かれたJavaScriptのランタイムシステムである。
JSDocの構文とセマンティックスは、Javaに書かれるコードのドキュメンティングに使われる、Javadocのスキームに似ている。JSDocがJavadocと異なるのは、JavaScriptの動的な振る舞いを扱うために特化している点である。
JSDocタグ
モダンなJSDocでよく使用されるアノテーションの一部を紹介する。
例
JSDocの使用例
- GoogleのClosure LinterおよびClosure Compiler。後者は、型情報を抽出することで、JavaScriptの出力を最適化する。
- 有名なエディタSublime TextはJSDocをDocBlockrまたはDoxyDoxygenプラグインによってサポートする。
- JSDocの構文は、次の書籍内に詳細に記述されている。Apress book Foundations of Ajax ISBN 1-59059-582-3
- IntelliJ IDEA、NetBeans、RubyMineは、JSDocの構文を認識することができる。
- Eclipse IDEには、JSDoc構文を認識できるようにする拡張機能がある。EclipseをベースにしたAptana StudioはScriptDocをサポートしており、含まれているJavaScriptファイルはScriptDocでコメントされている。
- MozillaのインラインエディタMozileは、JSDocを使用している。
- Helmaアプリケーションフレームワークは、JSDocを使用している。
- SproutCoreのドキュメンテーションは、JSDocから自動生成されている。[1]
- Visual StudioやWebStormなどの統合開発環境（IDE）やテキストエディタは、JSDocのコメントに基づいたコード補完機能などのコーディング支援機能を提供している。
- オープンソースのエディタAtomは、atom-easy-jsdocプラグインによりJSDocをサポートしている。
脚注
関連項目
- ドキュメンテーションジェネレータの比較
- Google Closure Tools
外部リンク
- Use JSDoc: Index - JSDoc公式サイト。使用方法のチュートリアルとドキュメント
- GitHub - jsdoc/jsdoc: An API documentation generator for JavaScript. - JSDoc公式GitHub。最新のコードの公開場所
- "Annotating JavaScript for the Closure Compiler" - Google DeveloperウェブサイトにあるClosure Toolsのドキュメント
