2006-06-01 diary: JavaScriptコメントからのドキュメント生成に JSDocを利用する

JavaScriptコメントからのドキュメント生成に JSDocを利用する

JavaScriptコメントからドキュメント生成を行うツールとして JSDocを利用することにしました。

JavaScriptコメントからのドキュメント生成に JSDocを利用する

JavaScriptコメントからドキュメント生成を行うツールとして JSDocを利用することにしました。JSDocを利用すると Java言語のJavaDocに良く似たHTMLドキュメントを自動生成することができます。とても便利なツールです。

• ActivePerlのインストール http://www.activestate.com/ Windows上で JSDocを実行するためには、ActivePerlというPerl処理系をインストールする必要があります。

• JSDocのインストール http://jsdoc.sourceforge.net/ JSDocはアーカイブ取得後 ActivePerlのパッケージをインストールするという手順を通して実行可能になります。GPLライセンスの下に配布されています。

• JSDocの解凍

• ActivePerl へ HTML-Tempalteパッケージ (JSDoc) をインストール

  • ppm コマンドを起動
  • ppm> install HTML-Template
  • ppm> quit

• JSDocの実行

• perl -w jsdoc.pl ソースコード.js

関連する日記

• 2006/05/26 日記: 3rd. Developers' Loungeに参加 , Apple HeaderDocを Windowsで使う この日記を書いた時点では JavaScriptコメントからのドキュメント生成には HeaderDocが妥当と考えていました。しかし、現時点では JSDocを採用する方が妥当と考えています。

• 2006/06/12 日記: blancoCgのJavaScript対応について、APIリファレンス用のコメントをJSDoc対応させました 私が取り組んでいる ソースコード自動生成ライブラリ blancoCgのJavaScript対応について、JSDoc用のコメント自動生成をおこなうように機能強化しました。

疲労が抜けません

先日の日帰り大阪出張の疲れが抜けませんです。へろへろです。

この日記について

• ホームページ更新者: 伊賀 敏樹 / Tosiki Iga
• Diary / Facebook / LinkedIn / GitHub / Qiita / Mastodon / X(Twitter) / Amazon / Share on Twitter / top / いがぴょんについて / Powered by Igapyonv3
• 本サイトの見解は、私 個人のものであり、株式会社レザボア・コンサルティング は当個人的見解に一切責任を持ちません。