読者です 読者をやめる 読者になる 読者になる

Azureの小ネタ (改)

~Azureネタを中心に、色々とその他の技術的なことなどを~

JavascriptのコメントをJavadoc風に生成する

Nodeづくしで申し訳ありませんが備忘録。Azure SDK for Node.js のソースを見るときちんとJavadoc風のコメントが入っているのですが、リファレンスが見つからず、どこにあるんでしょか、というのが事の発端です。

まあ、無ければそれっぽいツールはあるだろうし作ってみよう。

  1. JSDocなるツールを見つけたがすでにobsolete
  2. 開発は、jsdoc toolkitに引き継がれているとのこと。

で、少し試してみたんですがフォルダを再帰でトラバースするように指定してもいくつかのソースがリファレンスになりません。Node.js固有の何かが邪魔しているのでしょうか。ドキュメントをよく見ると、

NOTICE: As of 27 June 2010 the JsDoc Toolkit Version 2 project is no longer accepting any new Feature Request tickets. Any Feature Request tickets submitted after that date will be deleted without comment.

Subscribe to the Users List for announcements regarding what features will be included in the upcoming release of JSDoc 3.

JSDoc 3に開発は引き継がれているとのこと。最終的に以下を発見。

Windows向けのスクリプトが無さそうなので、見よう見まねで

>java -cp lib/js.jar org.mozilla.javascript.tools.shell.Main -modules node_modules -modules rh
ino_modules -modules . jsdoc.js -r c:\node\node_modules\azure\lib

とやったらなにやら生成されました。見方がいまいち分からないんですけど、jsdoc toolkitでは生成されなかった部分も生成されました。ただ、内容的な正しさが判断できません。

以下のような感じで表示されました。