SE Tools

JsDocのVersion３が公開されていたので、使ってみました。
※JavaScriptのソースのコメントから、ドキュメントを生成してくれるツール

1. JsDocソース入手
   まずは、ソースの入手から、GitHubに公開されています。
   
   JsDoc３　-GitHub
   
   
   
   Zip マークから全てのファイルをダウンロードできます。
   
   ダウンロード後、任意のフォルダに解凍します。
   
   例）C:\jsdoc3　に解凍。　jsdoc3-jsdoc-f4ea8f2　が出来ました。
   ※2012/08/03時点　
    
2. JREの入手
   JsDocの動作にJRE(Java Runtime Environment)が必要です。
   
   最新を入手します。
   
   JRE - Oracle
   
   
   
   正常にインストールが完了したら、バージョンを確認
   
   コマンドプロンプトからチェックします。 次のVersionでは動作しました。
   
   >java -version
   java version "1.7.0_05"
   Java(TM) SE Runtime Environment (build 1.7.0_05-b05)
   Java HotSpot(TM) Client VM (build 23.1-b03, mixed mode, sharing)
    
3. テストの実行
   
   JｓDocを解凍したフォルダでテスト実行。
   初回は、エラーが２つ表示されます。
   >Jsdoc -T
   
   Running Tests
   [  Envjs/1.6 (Rhino; U; Windows XP x86 5.1; en-US; rv:1.7.0.rc2) Resig/20070309
   PilotFish/1.2.13  ]
   ........
   （続く）
   
   
   Failures:
   jsdoc/config constructor with empty
    
     1) should be possible to construct a Config with an empty arguments
     Message:
       Expected undefined to equal [  ].
     Stacktrace:
       undefined
    
   jsdoc/config constructor with {}
    
     1) should be possible to construct a Config with JSON of an object literal th
   t is emptys
     Message:
       Expected undefined to equal [  ].
     Stacktrace:
       undefined
    
   Finished in 1.578 seconds
   333 tests, 582 assertions, 2 failures
   
   .....
    
   Finished in 0.015 seconds
   5 tests, 7 assertions, 0 failures
   
   
   2度目の実行でテスト成功となります。
   

   >jsdoc -T

   Running Tests

   [  Envjs/1.6 (Rhino; U; Windows XP x86 5.1; en-US; rv:1.7.0.rc2) Resig/20070309

   PilotFish/1.2.13  ]

   ........
   （続く）

   
   

   Finished in 1.578 seconds

   333 tests, 582 assertions, 0 failures

   

   .....

    

   Finished in 0.016 seconds

   5 tests, 7 assertions, 0 failures

   
4. ドキュメントの生成
   試しに、JsDoc.js　のソースから　ドキュメントを生成してみます。
   
   >jsdoc jsdoc.js
   
   
   
   フォルダ OUTが生成されて、中にIndex.html が生成されています。
    
   
   
   出力された内容は、ソースと見比べるとわかります。
   出力内容には、Source 欄にファイル名とLine（行数）が示されています。
   
   
   
   ソースはこちら
   
   
   ちなみにヘルプは jsdoc --help　です。

参考ホームページ
JsDoc Toolkitによる開発効率向上を目指して - @it
JsDoc タグリファレンス

[0回]