JSDoc3:JavaScriptのコメントをJavaDocのように出力する

ラベル:

Blogger:SyntaxHighlighter(1)ブログにソースコードを綺麗に表示させるで導入したSyntaxHighlighterのソースをみると/** コメント */というふうにJavaDocの形式でコメント入っています。これをJSDoc3で出力できるかやってみました。

Mozilla Rhino版JSDoc3をインストール


JSDoc3にはnode.jsで動くものとMozilla Rhinoで動くものの2種類があります。

node.jsで動く方を使おうと思ったのですが、Windows7でgitのインストールの仕方がわからなかったので途中で諦めて、Mozilla Rhinoで動く方をインストールしました。

JavaScriptのAPIドキュメント生成ツールを調べてみたら、YUIDocが割とよかった - terurouメモ

このページを参考にさせていただきました。

このページ自体はYUIDocを推奨していますがこれもnode.jsを使うみたいですのでJSDoc3のMozilla Rhino版を使うことにしました。

JSDoc3の開発者側の方が登場したコメントでのやりとりが面白いです。

オープンソース関係の人々の掲示板などでのプロフェッショナルな対応はとてもお手本になりますね。

LibreOfficeの掲示板ではMicrosoft Officeと比較してなじられているのに対して根気よく対応された回答をよくみかけます。

そこで交わされるQ&Aはとても役立ちます。

Mozilla Rhino版JSDoc3にはJREが必要です。

MRI(1)Javaで動くMRIシミュレーターVirtual MRIで書いたようにjava.com: あなたとJavaからインストールできます。

インストール方法と使い方はjsdoc3/jsdoc · GitHubInstalling JSDoc for Mozilla Rhino以下にあります。

Tags · jsdoc3/jsdoc · GitHubからいろいろなバージョンをzipファイルでダウンロードできます。

解凍してでてきたフォルダを適当に改名して適当な場所に移します。

V3.3.0にしろV3.2.2にしろ、パスに空白やアンダーバーが入っているとちゃんと動きませんでした。

C:\に解凍したフォルダを置いて使ってみました。

使い方は簡単 jsdoc jsファイル とするのみ


試しにJSDoc3のフォルダにあるjsdoc.jsを入力してみました。

JSDoc3のフォルダからShift+右クリック、コマンドウィンドウをここで開く。

あとはjsdoc jsdoc.jsとするだけです。

JSDoc3のフォルダにoutというフォルダが生成されそこにhtmlファイルが生成されました。


こんな感じになります。

ちなみにSyntaxHighlighterのshCore.jsではV3.3.0でもV3.2.2でもhtmlファイルが出力できませんでした。

JavaScriptのAPIドキュメント生成ツールを調べてみたら、YUIDocが割とよかった - terurouメモ

に書いてあるようにコメントの書き方の問題かもしれません。

(2015.9.6追記。linuxBean14.04のjsdocでは問題なく出力できました。linuxBean14.04(59)jsdocのインストール)

参考にしたサイト


JavaScriptのAPIドキュメント生成ツールを調べてみたら、YUIDocが割とよかった - terurouメモ
JSDoc3についても解説されています。

jsdoc3/jsdoc · GitHub
JavaScriptでJavaのJavaDocのようにコメントを出力するツールJSDoc3。
PR

0 件のコメント:

コメントを投稿