はじめに

What is JsDoc?

JsDocとは、JavaDocライクなドキュメント作成ツールです。

JavaScriptは非常に柔軟な言語であるため、ドキュメントなしに他人のコードを読むことはかなり骨の折れる作業です。

しかし、いちいちドキュメントを書く作業もまた骨の折れる作業です。

JsDocはドキュメントを書く手間を大幅に低減してくれます。

あなたも手軽に他人に読んでもらえるプログラミングをしませんか。

注意喚起

JsDoc3 はいまだ安定版ではありません(Apr. 2013)。ドキュメントの品質を確保しなければならない場合は 旧バージョンの JsDoc Toolkit を使うことを薦めます。