ITエンジニア/デザイナ向けにオープンソースを毎日紹介

JSDoc

  • 2005/12/29

JSDoc サムネイル

JavaScriptにもドキュメントを

JavaScriptのソースからドキュメントを生成します。

JavaScriptにもドキュメントを

JSDoc スクリーンショット

Webのシステム開発においては仕様が度々変更される。まるでそれが当たり前であるかのようにだ。若干の修正は致し方ないが、根本から変わるような事が平然と起こりえる。恐ろしい世界だ。

そんな中にあって、ドキュメントだけはしっかりと要求されたりする。整備がきちんとされる保証もないので、ナンセンスだとは思いつつも作らなければならない。そんな時にJavaDocやPHPDocに代表されるソース(内のコメント)から起こされるドキュメントは非常に便利な存在だろう。

本日紹介するオープンソース・ソフトウェアはJSDoc、JavaScriptのドキュメント生成ソフトウェアだ。

数々の言語に対して同様の仕組みがなされてきたが、遂にJavaScriptの登場だ。最近はAjaxやprototype.jsの隆盛に伴って大型のしっかりとしたJavaScriptが組まれるようになっているので丁度良いのではなかろうか。

処理自体はPerlスクリプトで行われる。出力形式はHTML、XML、そしてXMI(UMLのXML形式)だ。ファイルを指定してスクリプトを実行すれば、簡単に指定フォーマットで出力がなされる。フッター等、オリジナルファイルの指定もオプション一つで行える。

JavaScriptは以前の単純なアクション追加やインタラクティブ性を高めると言った印象が強く、煩雑な関数が乱立しやすい。JSDocは、開発手段の確立に一役買ってくれるかも知れない。

JSDocレビューはこちら

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2