JsDoc Toolkit Ant Task - JsDoc Toolkitを使う！

JsDoc Toolkitを使う！内検索 / 「JsDoc Toolkit Ant Task」で検索した結果

JsDoc Toolkit Ant Task
トップページドキュメントの作成 JsDoc Toolkit Ant Task JsDoc Toolkit Ant TaskはJsDoc ToolkitをAntタスクとして実行するラッパープログラムです。JsDoc Toolkitのコマンドラインオプションのほとんどを使用でき、かつAntビルドファイル内で簡単にJsDoc Toolkitを利用できます。このページはhttp //code.google.com/p/jsdoc-toolkit-ant-task/を元に作成しました。ここではAntそのものの説明は行いません。公式サイトやWeb上の情報を参照してください。準備インストール下記URLから jsdoctoolkit-ant-task-1.0.jar をダウンロードし、適当なディレクトリに配置して...
ドキュメントの作成
... 以下のページでは、JsDoc Toolkitの実行方法について説明します。コマンドラインオプション JsDoc Toolkitを実行する最も基本的な方法は、コマンドラインからの実行です。 JsDoc Toolkitの動作を指定するための様々なオプションの使い方について説明します。 JsDoc Toolkit Ant Task JsDoc ToolkitをラップしたAntタスク「JsDoc Toolkit Ant Task」を紹介します。 JsDoc ToolkitをAntから扱えるようになると非常に便利です。公式サイト：http //code.google.com/p/jsdoc-toolkit-ant-task/
メニュー
...ンオプション JsDoc Toolkit Ant Task カスタマイズテンプレート publish.js JsPlateファイルプラグインの追加組み込みオブジェクトリファレンス組み込みオブジェクトリファレンス JsDoc Toolkit版ダウンロードリンク JsDoc Toolkit official site JsDoc Toolkit Users Group 更新履歴取得中です。管理人：aiaswood ご意見・お問い合わせ等はこちらまでどうぞ今日： - 昨日： - 合計： - - , - , - , - , - , - , - , - , - , - , - , - , -
コンテンツ
...ンオプション JsDoc Toolkit Ant Task カスタマイズテンプレート publish.js JsPlateファイルプラグインの追加組み込みオブジェクトリファレンス組み込みオブジェクトリファレンス JsDoc Toolkit版ダウンロード
トップページ
このサイトについて「JsDoc Toolkitを使う！」は、JavaScriptドキュメンテーションツールであるJsDoc Toolkitの使い方を紹介するサイトです。JsDoc Toolkitは非常に優れたツールですが、まとまった日本語の情報が少ないようなので何となく作ってみました。このサイトの内容はあくまで管理人個人の理解に基づくものです。ご利用は自己責任でお願いします。記載されている情報はバージョン 2.4.0 時点のものです。 JsDoc Toolkitとは JsDoc Toolkit は、JavaScriptソースコードに記述されたコメントを元に、HTML形式のドキュメントを生成するオープンソースのフリーソフトウェアです。作者はMichael Mathews、ライセンスはMITライセンスです。 JavaScriptのドキュメント作成ツールとし...
コマンドラインオプション
...、コマンドラインからJsDoc Toolkitを実行しドキュメントを作成する方法について説明します。公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptionsを元に作成しました。目次サンプルの動作環境について記述例入力ファイルの指定オプションテンプレートを指定する出力ディレクトリを指定するディレクトリを再帰的にたどるソースファイルの拡張子をカスタマイズするドックコメントの書かれていない関数を出力するコンフィグファイルを使うサンプルシェルスクリプト関連項目サンプルの動作環境についてこのページに記載...
インストール
... このページでは、JsDoc Toolkitとその動作環境のセットアップ手順について説明します。なお以下の作業において、OSはWindowsとします。 JREのインストールまだインストールされていなければ、JsDoc Toolkitの動作環境であるJRE(Java Runtime Environment)をインストールします。バージョン2.3.2の時点で公式に動作確認されているJREのバージョンは下表のとおりですが、特に理由がなければ、その時点の最新のバージョンを利用することをお勧めします。 Windows XP java version "1.6.0_03"; Java(TM) SE Runtime Environment (build 1.6.0_03-b05) Mac OS X 10.5 ...
プラグインの追加
...ンの追加 JsDoc Toolokitのバージョン2から、ソースコードに対するパース処理に（結果がテンプレートに渡されるより前に実行される処理として）ユーザー独自の機能を挿入することができるようになりました。この仕組みはプラグインと呼ばれ、JsDoc Toolkitの動作をユーザーの希望にあわせて変更する便利で可搬性のある方法です。このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/Pluginsを元に作成しました。インストールプラグインのインターフェースはシンプルに設計されています。プラグイン使用時のインストール作業は、プラグインファイルを app/plugins ディレクトリに保存すること－これだけです。JsDoc Toolkitを起動すると、プラグインは自動的にロー...
@link
... 注意：JsDocToolkitはドキュメント内から Printer を自動的に探し出し、HTMLリンクを作成します。関連項目 @linkタグは@seeタグと似た動作をするものの、@seeタグの中にこのタグを記述することはできません。
ダウンロード
...されます。 JsDoc Toolkitのバグにより、(1)のような" "を含むファイルパスはコマンドライン上の指定では正しく解釈されません。この問題を回避するため、aias-frameは(2)のようにパスの２文字目が"?"だった場合はそれを" "に置き換えてファイルを読み込むようになっています。尚、コンフィグファイルを使用している場合はこの問題は発生しません。 (1)‐D="overview c \overview.js" (2)‐D="overview c?\overview.js" -- c \overview.js 概要ページのドックコメント内では、@appNameタグという特殊なタグを使用できます。@appNameタグにはアプリケーション名を設定...
メタタグ
...タタグとして扱われ、JsDoc Toolkitに対し何らかの処理を指示する特別な構文として機能します。このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/MetaTagsを日本語に翻訳、一部を再構成したものです。タグの共有「タグの共有」命令を使うと、指定された範囲のコード内に記述された全ての要素に対しタグのセットを適用できるようになります。構文 /**#@+ anyTags */ .... /**#@-*/ anyTags -- 必須：共有したいタグのグループ注意：この指示の効果は、ファイルの終端に達するか、 /**#@-*/ ドックコメントが現れるまで続きます。例 ...
@constant
トップページドックコメントの書き方タグリファレンス @constant @constantタグは項目が定数であることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstant 構文 @constant 例 /** * @constant */ const acceleration = 9.80665;
プログラムの更新履歴
...9/10) JsDoc Toolkit 2.3.2 までの更新に対応 1.1.0 (2009/08/25) クラスリストにクラスメンバ表示機能を追加ドキュメント内のキーワードをパラメータ化細かい不具合修正など 1.0.0 (2009/07/25) 新規作成 jsdoc-ja 1.3.0 (2011/09/02) JsDoc Toolkit 2.4.0 ベースに移行 1.2.1 (2009/09/08) JsDoc Toolkit 2.3.2 ベースに移行 1.2.0 (2009/07/04) symbolExtensionsプラグインへの対応を追加 1.1.0 (2009/06/27) Js...
組み込みオブジェクトリファレンス
...プレートで使用できるJsDoc Toolkitの組み込みオブジェクトとそのメンバの一部を説明します。 JsDoc Tookitのソースコードから直接作成した、より詳細なドキュメントはこちらをご覧下さい。目次 JSDOC 名前空間 JSDOC.JsPlate クラス JSDOC.SymbolSet クラス JSDOC.Symbol クラス JSDOC.DocComment クラス JSDOC.DocTag クラス JSDOC.PluginManager 名前空間 SYS 名前空間 IO 名前空間 LOG 名前空間 Dumper名前空間 Link クラス関数組み込みクラスの拡張 ReqExp クラス String クラ...
ドックコメントの書き方
...的な書き方 JsDoc Toolkitのドックコメントの書き方はJavaDocの記法をベースにしています。基本的な記述ルールは以下のとおりです。ドックコメントは /** から始まり */ で終わるコメントブロックで、複数行に渡って書くことができます。ドックコメントはタグと説明文から構成されます。一般的にドックコメントは、その直後に現れるソースコードを対象にする記述と解釈されます。（ただし、@nameタグなど例外もあります）タグは"@"から始まるキーワードで、ドックコメントの対象に対し様々な意味づけを行います。タグは説明文を伴うこともあります。タグは行の先頭に書かれている必要があります。@linkタグを除き、行の途中に書かれたものはタグと解釈されませんので注意してください。説明文はHTMLテキストで、HT...
publish.js
...ically by JsDoc Toolkit. */ function publish(symbolSet) { } 上の例で、 publish 関数に symbolSet というパラメータが定義されていることに気づいたかもしれません。このパラメータは厳密には必須ではありませんが、従来からの慣習として付けることが推奨されています。 JsDoc Toolkitが全てのソースファイルをパースし終わると publish 関数が自動的に呼び出されます。そしてパースされた結果は JsDoc.SymbolSet 型の単一のオブジェクトにまとめられ、 publish 関数にパラメータとして渡されます。つまり publish 関数はSymbolSet内のシンボルを処理する何からのコードを含んでおり、それによって出力ファイルを作成することが想定されているのです。 ...
@throws
トップページドックコメントの書き方タグリファレンス @throws @throwsタグには、関数（やメソッド）が投げる可能性のある例外について記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagThrows 別名 @exception 構文 @throws {exceptionType} exceptionDescription exceptionType -- 省略可：関数が投げる例外のタイプ exceptionDescription -- 省略可：例外の説明例 /** * @throws {OutOfMemeory} If the file is too big. ...
@augments
トップページドックコメントの書き方タグリファレンス @augments @augmentsタグは、ドキュメント化されたクラスが別のクラスを継承しており、そのクラスのメソッドやプロパティを使用できることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagAugments 別名 @base, @extends 構文 @augments otherClass otherClass -- 必須：このクラスの継承元クラスのネームパス例 /** * @constructor */ function GeneralWriter() { } /** * @c...
@returns
トップページドックコメントの書き方タグリファレンス @returns @returnsタグには、関数またはメソッドの戻り値を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagReturns 別名 @return 構文 @returns {returnType} returnDescription returnType -- 省略可：戻り値のデータ型 returnDescription -- 省略可：戻り値の説明 @returnsタグは複数記述が可能です。例 /** * @returns {Array} Lines from the file. */ ...
@fileOverview
トップページドックコメントの書き方タグリファレンス @fileOverview @fileOverviewタグには、ファイル全体についての説明を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview 別名 @overview, @projectdescription 構文 @fileOverview fileDescription otherTags fileDescription -- 必須：ファイルの説明 otherTags -- 現在@fileOverviewと共に使用できるタグとして以下がサポートされています。：@author、@version 注意：@fileOve...
@class
トップページドックコメントの書き方タグリファレンス @class @constructorタグと同じく、@classタグが付いた関数はコンストラクタとみなされます。ただしこのタグの目的はコンストラクタというよりも、クラスそのものを説明することにあります。 http //code.google.com/p/jsdoc-toolkit/wiki/TagClass 別名 @classdescription 構文 @class description description -- 省略可：クラスの説明例この例には２つの説明文が存在しています。1行目の文はタグ付けされておらず、コンストラクタ関数について説明しています。2行目の文は@classタグの一部であり、 Perso...
@event
トップページドックコメントの書き方タグリファレンス @event @eventタグは、自分と同じ名前を持つイベントが発生したときに実行することができる関数について記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagEvent 構文 @event @eventタグの構文は@functionタグと同一です。例シンプルに関数をイベントとしてタグ付けできます。 /** * @event * @param {Boolean} clockwise */ Cocktail.prototype.stir = function(clockwise) { } あるいは...
@memberOf
トップページドックコメントの書き方タグリファレンス @memberOf @memberOfタグは、要素に対し任意の"親"階層を規定することを可能にします。 http //code.google.com/p/jsdoc-toolkit/wiki/TagMemberOf 別名 @member, @memberof 構文 @memberOf parentNamepath parentNamepath -- 必須：要素が属する階層のネームパス例 var Tools = {}; /** @namespace */ Tools.Dom = {}; /** @memberOf Tools.Dom */ ...
タグリファレンス
...ignore JsDocToolkitがその項目を無視するようにします。 @inner 関数を内部関数とします。（@privateも参照してください） @lends オブジェクトリテラル内のメンバが、このタグで指定されたクラスのメンバであることを示します。 @link 他の要素へのリンクを作成します。@seeタグと似ていますが、こちらは他のタグのテキスト内で使います。 @memberOf この項目が、指定されたクラスのメンバであることを示します。 @methodOf @functionタグと@memberOfタグを合わせて記述したのと同じ働きをします。 @name JsDocToolkitに対し、このタグで指定された名称を周辺のコードとは無関係にドキュメントの...
JsPlateファイル
...によって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。 JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。目次概要データを受け取る JsPlateの構文 + ... + ! ... ! # ... # for ... /for if ... /if 関連項目概要 JsPlateファイルはJSPやPHPと同様に、ドキュメントとして出力されるテキストデータ内にプログラムを埋め込む形式で記述されます。例えばJsDoc Toolkitの標準テンプレートである"jsdoc"で個々のクラス...
@namespace
トップページドックコメントの書き方タグリファレンス @namespace @namespaceタグは、あるオブジェクトが単一のグローバルな名前のもとにプロパティやメソッドの集合を保持する"名前空間"として使用されていることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagNamespace 構文 @namespace description description -- 省略可：この名前空間についての説明例この例では load 関数は Extensions.PluginManager のメンバとして現れます。 /** @namespace Holds functi...
@borrows
トップページドックコメントの書き方タグリファレンス @borrows @borrowsタグは、このクラスが元々別のクラスで定義されたメソッドまたはプロパティを保持していることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagBorrows 別名 @inherits 構文 @borrows otherMemberName as thisMemberName otherMemberName -- 必須：借用元メンバへのネームパス thisMemberName -- 必須：借用したメンバの、このクラスにおける名前例 /** @constructor */ function Remote...
@exports
トップページドックコメントの書き方タグリファレンス @exports @exportsタグはある要素を、コードとは異なる名前を持つ異なる要素としてドキュメントに出力できるようにします。コード内では別名で記述されている要素を、本来の名前を使ってドキュメント化したいという場合に役に立つでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExports 導入バージョン -- 2.2.0 構文 @exports codedName as documentedName codedName -- 必須：コード内で使われている名前 documentedName -- 必須：ドキュメント化するときに使用したいネームパス例 /...
@description
トップページドックコメントの書き方タグリファレンス @description @descriptionタグを使用して、ドキュメントに含まれるほぼ全ての要素（関数、変数、コンストラクタなど）に対し説明文を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDescription 別名 @desc 構文 @description description description -- 必須：この項目の説明 @descriptionタグは複数記述できます。例要素について説明文を書くことは非常に有用でありまた一般的でもありますが、このタグはごくまれにしか使われません。というのも慣例的に、ドックコメ...
@param
... 基本 JsDocToolkitは関数宣言をパースし自動的にパラメータ名を見つけるので、技術的には@paramタグの使用は必ずしも必須ではありません。しかし@paramタグが提供するデータ型情報や説明文はとても有用なものです。最も基本的な@paramタグの記述は、単にパラメータ名を示すだけです。これはソースコード内の同名のパラメータにマッチするはずです。 /** * @param userName */ function logIn(userName) { // ... } データ型情報データ型情報をドキュメントに出力するには、型名を { } で囲んで記述します。 /** * @param {String} us...
@lends
...ントが全く無い場合、JsDoc Toolkitは Person もその２つのメソッドも認識しません。メソッドをドキュメント化するためにはオブジェクトリテラルの直前に@lendsタグを記述して、JsDoc Tollkitに対しこのオブジェクトのメンバが Person という名前の要素に"lent"（貸与）されていることを伝える必要があります。 /** @class */ var Person = makeClass( /** @lends Person */ { initialize function(name) { &n...
@wiki全体から「JsDoc Toolkit Ant Task」で調べる