JsDoc Toolkitを使う！内検索 / 「インストール」で検索した結果

• インストール
  トップページ インストール このページでは、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) ...
• コンテンツ
  コンテンツ トップページ インストール ドックコメントの書き方 タグリファレンス ネームパス インライン・ドックコメント メタタグ ドキュメントの作成 コマンドラインオプション JsDoc Toolkit Ant Task カスタマイズ テンプレート publish.js JsPlateファイル プラグインの追加 組み込みオブジェクト リファレンス 組み込みオブジェクト リファレンス JsDoc Toolkit版 ダウンロード
• メニュー
  ...トップページ インストール ドックコメントの書き方 タグリファレンス ネームパス インライン・ドックコメント メタタグ ドキュメントの作成 コマンドラインオプション JsDoc Toolkit Ant Task カスタマイズ テンプレート publish.js JsPlateファイル プラグインの追加 組み込みオブジェクト リファレンス 組み込みオブジェクト リファレンス JsDoc Toolkit版 ダウンロード リンク JsDoc Toolkit official site JsDoc Toolkit Users Group 更新履歴 取得中です。 管...
• JsDoc Toolkit Ant Task
  ... 準備 インストール 下記URLから jsdoctoolkit-ant-task-1.0.jar をダウンロードし、適当なディレクトリに配置してください。 http //code.google.com/p/jsdoc-toolkit-ant-task/downloads/list 動作環境 JsDoc Toolkit Ant Taskの動作には、JsDoc Toolkit本体がインストールされた環境が必要です。 例 Antビルドファイル内でJsDoc Toolkit Ant Taskを使用する手順を説明します。 まず、 jsdoctoolkit タスクを定義します。ダウンロードした jsdoctoolkit-ant-task-1.0.jar とRhino - js.jar へのクラスパスを必ず設定してください。 ...
• コマンドラインオプション
  ... 6 ※「%JREインストールディレクトリ%￥bin」にpathが設定済みとする カレントディレクトリ：JsDoc Toolkitのインストールディレクトリ 記述例 java -jar jsrun.jar app\run.js c \example\js\ -t=templates\jsdoc -d=c \out\example -a JsDoc ToolkitはJavaで実装されたJavaScript実行環境である"Rhino"上で動作します。RhinoはJsDoc Toolkitの配布パッケージに含まれており、実行アプリケーション"jsrun"から起動されます。そしてjsrunはJsDoc Toolkitのメインスクリプトである"run.js"へのパスをパラメータに...
• トップページ
  ...c Toolkitのインストールについては、こちらを参照してください。 ドキュメント生成のためのコメント（ドックコメントと呼びます）記法はJavaDocをベースにしており、比較的容易に習得することができます。ドックコメント付きのソースコードと、そこからJsDoc Toolkitによって生成されたドキュメントのスクリーンショットを下に示します。 + クリックするとソースコードを展開します... /**  * 新しいStringBufferオブジェクトを作成する。  * @class 文字列をバッファリングし、文字列の効率的な結合を行うクラス  * @param {String} [str] バッファリングする文字列  * @example alert(new StringBuffer("このように&qu...
• プラグインの追加
  ...。 インストール プラグインのインターフェースはシンプルに設計されています。プラグイン使用時のインストール作業は、プラグインファイルを app/plugins ディレクトリに保存すること－これだけです。JsDoc Toolkitを起動すると、プラグインは自動的にロード・実行されます。 管理人が作成したプラグインをこちらからダウンロードできます。 実際に app/plugins ディレクトリの中を見ると分かりますが、いくつかの標準機能はプラグインとして実装されています。それらのソースを読むことでプラグインに対する理解はより深まるでしょう。 API プラグインを記述する方法もまたシンプルです。まず新しいテキストファイルを作成します；名前は自由につけてかまいません。プラグインファイルの内容は、以下のパターンに従っている...
• タグリファレンス
  トップページ ドックコメントの書き方 タグリファレンス このページは公式サイトのタグリファレンスを日本語に翻訳、一部を再構成したものです。 タグ一覧 @augments このクラスが継承している 基底クラス を示します。 @author ドキュメント化されたコードの作成者を示します。 @argument @paramタグの非推奨の別名です。 @borrows このクラスのメンバが他のクラスのメンバを借用していることを表します。 @class （コンストラクタに対し）クラスの説明を記述します。 @constant この項目の値を定数として扱うべきであることを示します。 @constructor 関...
• @constructor
  トップページ ドックコメントの書き方 タグリファレンス @constructor @constructorタグは、関数がコンストラクタ、つまりnewキーワードと共に呼び出され、クラスインスタンスを返す関数であることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstructor 別名 @construct 構文 @constructor 例 /**  * Creates a new Person.  * @constructor  */ Person = function() { } var p = new Person(); 関連項目 @cla...
• ネームパス
  トップページ ドックコメントの書き方 ネームパス このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/NamePathsを日本語に翻訳、一部を再構成したものです。 概要 JsDoc Toolkitが作成するドキュメントにおいて、ドキュメント内のほかの場所にあるJavaScriptの値（関数、クラス、メソッドなど）への参照を記述したいケースは多くあります。そしてその場合に必要となるのは、その値へのパスを示すユニークな識別子です。ネームパス(NamePaths)はまさにそのような識別の手段を提供するもので、インスタンスメンバ、スタティック（静的）メンバ、内部変数も明確に区別できるようになっています。 例 以下に示すクラスには、"say"という...
• ドックコメントの書き方
  トップページ ドックコメントの書き方 このページ以下では、ドックコメントの書き方について説明します。 各タグの詳細なリファレンスはこちらを参照してください。 基本的な書き方 JsDoc Toolkitのドックコメントの書き方はJavaDocの記法をベースにしています。基本的な記述ルールは以下のとおりです。 ドックコメントは /** から始まり */ で終わるコメントブロックで、複数行に渡って書くことができます。ドックコメントはタグと説明文から構成されます。 一般的にドックコメントは、その直後に現れるソースコードを対象にする記述と解釈されます。（ただし、@nameタグなど例外もあります） タグは"@"から始まるキーワードで、ドックコメントの対象に対し様々な意味づけを行います。タグは説明...
• 組み込みオブジェクト リファレンス
  トップページ カスタマイズ 組み込みオブジェクト リファレンス このページではテンプレートで使用できるJsDoc Toolkitの組み込みオブジェクトとそのメンバの一部を説明します。 JsDoc Tookitのソースコードから直接作成した、より詳細なドキュメントはこちらをご覧下さい。 目次 JSDOC 名前空間 JSDOC.JsPlate クラス JSDOC.SymbolSet クラス JSDOC.Symbol クラス JSDOC.DocComment クラス JSDOC.DocTag クラス JSDOC.PluginManager 名前空間 SYS 名前空間 IO 名前空間 LOG 名前空間 Dumper名前空間 Link クラス...
• @class
  トップページ ドックコメントの書き方 タグリファレンス @class @constructorタグと同じく、@classタグが付いた関数はコンストラクタとみなされます。ただしこのタグの目的はコンストラクタというよりも、クラスそのものを説明することにあります。 http //code.google.com/p/jsdoc-toolkit/wiki/TagClass 別名 @classdescription 構文 @class description description -- 省略可：クラスの説明 例 この例には２つの説明文が存在しています。1行目の文はタグ付けされておらず、コンストラクタ関数について説明しています。2行目の文は@classタグの一部であり、 Perso...
• インライン・ドックコメント
  トップページ ドックコメントの書き方 インライン・ドックコメント このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/InlineDocsを日本語に翻訳、一部を再構成したものです。 インライン・ドックコメントは、関数（やコンストラクタ、メソッド）のパラメータや戻り値のデータ型をコード内への記述を可能にします。例えば以下のような場合を考えてみます。 /**   @param {String} name   @type Array  */ function getPerson(name) { } 上の例は、替わりにインライン・ドックコメントを使ってこのように書くことができます。 function getPe...
• @author
  トップページ ドックコメントの書き方 タグリファレンス @author @authorタグを使うと、コード（コンストラクタ、メソッド、プロパティ）の作成者を記録することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagAuthor 構文 @author authorDescription authorDescription -- 必須：名前、メールアドレスなど作成者についての情報 例 /**  * @author a href="mailto micmath@gmail.com" Michael Mathews /a  */ 1つのコメントの中に、複数の@auth...
• @example
  トップページ ドックコメントの書き方 タグリファレンス @example @exampleタグには、コンストラクタ、関数（またはメソッド）、変数の使い方を解説する小さなコードを記述できます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExample 構文 @example snippet snippet -- 必須：使用法を解説するごく小さいコード @exampleタグは複数記述できます。 例 /**  * @example  * var bleeper = makeBleep(3);  * bleeper.flop();  */ 注意 @exampleタグ...
• @namespace
  トップページ ドックコメントの書き方 タグリファレンス @namespace @namespaceタグは、あるオブジェクトが単一のグローバルな名前のもとにプロパティやメソッドの集合を保持する"名前空間"として使用されていることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagNamespace 構文 @namespace description description -- 省略可：この名前空間についての説明 例 この例では load 関数は Extensions.PluginManager のメンバとして現れます。 /**    @namespace Holds functi...
• @lends
  トップページ ドックコメントの書き方 タグリファレンス @lends @lendsタグは無名オブジェクト（オブジェクトリテラル）の全メンバが、指定された名前を持つオブジェクトのメンバであるかのようにドキュメント化します。無名オブジェクトを引数にとり、そのオブジェクトのメンバを元に名前付きのクラスを生成する関数が用いられるような場合に、このタグを使いたいと思うでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagLends 別名 @scope 構文 @lends symbolAlias symbolAlias -- 必須：メソッド、プロパティが渡されるオブジェクト（クラス）の完全なネームパス 注意：@lendsタグを含むドックコメント...
• ダウンロード
  トップページ ダウンロード このページでは、管理人が作成したテンプレートとプラグインを公開します。 ここで公開されているプログラムの使用は商用・個人を問わず自由です。ただしそこから発生する結果について作成者は一切の責任を負わないものとします。 バグなどお気付きの点がありましたらこちらまでお願いします。 目次 テンプレート aias-frame jsdoc-ja プラグイン 一括ダウンロード additionalOptions --- いくつかのオプションを追加する browserObjects --- ブラウザ組み込みオブジェクトシンボルの自動生成 easyLink --- リンクを簡単に作成する publishSrcHilite ---...
• @public
  トップページ ドックコメントの書き方 タグリファレンス @public @publicタグは、内部変数がpublicなメンバとしてドキュメント化されるようにします。 http //code.google.com/p/jsdoc-toolkit/wiki/TagPublic 構文 @public 例 /**  * @constructor  */ function Foo() {     /** @public */     function inner() {     } } 上の例では、 inner 関数は ...
• @static
  トップページ ドックコメントの書き方 タグリファレンス @static @staticタグは、その要素が、要素の属するオブジェクトのインスタンス化をしなくてもアクセス可能な静的メンバであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagStatic 構文 @static 例 var Hello = {}; /**  * @static  */ Hello.World = function() {     alert("Hello world"); } このケースでは、 World 関数は Hello オブジェクトのスタティ...
• @constructs
  トップページ ドックコメントの書き方 タグリファレンス @constructs @lendsタグが使われている場面で、@constructsタグは特定の関数がクラスコンストラクタであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstructs 構文 @constructs 例 var Person = makeClass(     /**         @lends Person.prototype      */   &nb...
• @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 */ ...
• @borrows
  トップページ ドックコメントの書き方 タグリファレンス @borrows @borrowsタグは、このクラスが元々別のクラスで定義されたメソッドまたはプロパティを保持していることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagBorrows 別名 @inherits 構文 @borrows otherMemberName as thisMemberName otherMemberName -- 必須：借用元メンバへのネームパス thisMemberName -- 必須：借用したメンバの、このクラスにおける名前 例 /** @constructor */ function Remote...
• @param
  トップページ ドックコメントの書き方 タグリファレンス @param @paramタグには、関数（コンストラクタ、メソッド）のパラメータについての情報を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagParam 別名 @argument ※この別名は非推奨です。 構文 @param {paramType} paramName paramDescription paramType -- 省略可：パラメータのデータ型 paramName -- 必須：パラメータ名 paramDescription -- 省略可：パラメータの説明 例 /**  * @param userName T...
• @description
  トップページ ドックコメントの書き方 タグリファレンス @description @descriptionタグを使用して、ドキュメントに含まれるほぼ全ての要素（関数、変数、コンストラクタなど）に対し説明文を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDescription 別名 @desc 構文 @description description description -- 必須：この項目の説明 @descriptionタグは複数記述できます。 例 要素について説明文を書くことは非常に有用でありまた一般的でもありますが、このタグはごくまれにしか使われません。というのも慣例的に、ドックコメ...
• @see
  トップページ ドックコメントの書き方 タグリファレンス @see @seeタグは、この項目と関連する他の要素や外部リソースへのリンクを作成します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagSee 構文 @see seeDescription seeDescription -- 必須：参照先リソースの説明 例 最初の単語がドキュメント内の要素の場合、その要素へのリンクが作成されます。そうでなければ、テキストはHTMLテキストとして入力されたまま出力されます。（@linkタグは機能しないということです） /**  * @see ClassName#methodName  * @see The a ...
• カスタマイズ
  トップページ カスタマイズ 以下のページでは、JsDoc Toolkitをカスタマイズする方法について説明します。 テンプレート JsDoc Toolikitの機能は大きくソースコードのパースを担当するコア機能とドキュメントの整形と出力を担当するテンプレート機能に分けられます。テンプレートは-tコマンドラインオプションで簡単に切り替えられ、規定の形式に則ったテンプレートを用意すれば誰でも独自構成のドキュメントを作成することができるようになっています。 ここではテンプレート・システムの仕様と新しいテンプレートを作成する方法を説明します。 プラグインの追加 プラグインはバージョン2からの新しい機能で、ソースコードのパース段階のJsDoc Toolkitの動作にある程度の独自処理を追加する仕組みを提供します。ここではプラグインの仕様と作成方...
• @link
  トップページ ドックコメントの書き方 タグリファレンス @link @linkタグは他のタグテキストの中に挿入して、ドキュメント内の他の要素へのHTMLリンクを作成することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagLink 構文 @anyTag This is some text {@link otherSymbol}. anyTag -- 他のタグ otherSymbol -- 必須：リンク先の要素のネームパス 例 /**  * This is similar to a {@link Printer} object but can also print to files.  */ ...
• @private
  トップページ ドックコメントの書き方 タグリファレンス @private @privateタグは、この項目が他のオブジェクトから参照できないprivateなメンバであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagPrivate 構文 @private 例 /**  * @private  * @constructor  */ function Foo() {     function inner() {     }     this.notPrivate = func...
• publish.js
  トップページ カスタマイズ テンプレート publish.js publish.jsはテンプレート・システムの中心となるファイルで、ドキュメント出力のための実際の処理ロジックが記述されています。publish.jsはテンプレートフォルダの直下にに必ず publish.js というファイル名で存在していなくてはなりません。 目次 publish()関数 SymbolSetオブジェクトを使う Symbolオブジェクトを使う シンボルのフィルタリング JsPlateにデータを渡す ドキュメントの出力 静的ファイルのコピー publish.confプロパティ publish.js内での変数・関数宣言 publish.jsの文字エンコーディング 関連項目...
• プログラムの更新履歴
  トップページ ダウンロード プログラムの更新履歴 このページはダウンロードで公開されているプログラムの更新履歴一覧です。 目次 テンプレート aias-frame jsdoc-ja プラグイン additionalOptions browserObjects easyLink publishSrcHilite symbolExtensions tagLineBreak tagSynonyms テンプレート aias-frame 1.6.1 (2010/04/05) 説明文中に code タグで記述されたソースコードのハイライト表示機能を追加。 細かい機能追加、不具合修正など ...
• テンプレート
  トップページ カスタマイズ テンプレート このページは公式サイトの以下のページを日本語に翻訳、再構成したものです。http //code.google.com/p/jsdoc-toolkit/wiki/Templates http //code.google.com/p/jsdoc-toolkit/wiki/JsPlate テンプレート・システムの概要 JsDoc Toolkitはドキュメント出力のフォーマットを規定するための独自のテンプレート・システム"JsPlate"を持っています。JsDoc Toolkitの配布パッケージに同梱されている標準テンプレートはシンプルに"JsDoc"と名づけられています（templates/jsdoc/）。このページの解説を利用すれば、そのテンプレートをあなた...
• JsPlateファイル
  トップページ カスタマイズ テンプレート JsPlateファイル JsPlateファイルは実際に出力されるファイルの雛形となるファイルです。これらのファイルはpublish.jsによって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。 JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。 目次 概要 データを受け取る JsPlateの構文 + ... + ! ... ! # ... # for ... /for if ... /if 関連項目 概要 JsPlateファイルはJSPやPH...
• @name
  トップページ ドックコメントの書き方 タグリファレンス @name ほとんどのケースで、JsDoc Toolkitはドキュメント要素のネームパスを自ら決定することができます。この機能はユーザが必要最小限度のドックコメントを書くだけですみ、素晴らしく便利です。しかしながらネームパスが明確でないときもあり、その場合には@nameタグを使用してネームパスを明示的に指定することになります。 というものの、周辺のコードを無視し、ドックコメントを他から分離して扱うようJsDoc Toolikitに指示する@nameタグの使用には、注意が必要です。このタグはコードに現れない（または何らかの理由ではっきり示されていない）要素についての記述を可能にする、非常に強力な技術です。 http //code.google.com/p/jsdoc-toolki...
• @constant
  トップページ ドックコメントの書き方 タグリファレンス @constant @constantタグは項目が定数であることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstant 構文 @constant 例 /**  * @constant  */ const acceleration = 9.80665;
• @type
  トップページ ドックコメントの書き方 タグリファレンス @type @typeタグには、変数のデータ型、または関数（やメソッド）の戻り値のデータ型を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagType 構文 @type typeName typeName -- 必須：データ型の名前 例 /**  * @type Color  */ function getColor() { }
• @field
  トップページ ドックコメントの書き方 タグリファレンス @field @fieldタグは、JsDocToolkitに対し、この項目を関数でないものとして扱うように強制します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagField 構文 @field 例 /**  * @field  */ var pages = function(){ } @fieldタグがなければ、変数 pages は関数として出力されます。 関連項目 @functionタグ
• @since
  トップページ ドックコメントの書き方 タグリファレンス @since @sinceタグは、メソッドまたはプロパティがそこに記されたバージョンから追加されたことを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagSince 構文 @since versionDescription versionDescription -- 必須：バージョンについての説明 @sinceタグは複数記述できます。 例 /** @since version 1.0.1 */ function Remote() { } 関連項目 @versionタグ
• @requires
  トップページ ドックコメントの書き方 タグリファレンス @requires @requiresタグには、このコードの実行に必要なリソース（依存しているクラスなど）について記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagRequires 構文 @requires requireDescription requireDescription -- 必須：必要とされるリソースの名前または説明 例 /**  * @requires ColorPicker  */ function chooseColor() { }
• @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.  ...
• @function
  トップページ ドックコメントの書き方 タグリファレンス @function @functionタグは、JsDocToolkitに対し、この項目を関数として扱うように強制します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagFunction 構文 @function 例 /**  * @function  */ var paginate = paginateFactory(pages); @functionタグが無い場合、 paginate は一般的なオブジェクト変数として出力されます。プログラム実行時に paginate がどのようなデータ型を持つのか、コードの解析からは判断できないからです。 ...
• @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.  */ ...
• @version
  トップページ ドックコメントの書き方 タグリファレンス @version @versionタグには、そのコードが書かれたバージョン番号や、そのバージョンに関する情報を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagVersion 構文 @version versionDescription versionDescription -- 必須：このコードが書かれたバージョンに関する情報 例 /**  * @class  * @version 2001 beta release  */ function Hal() {     this.sin...
• @deprecated
  トップページ ドックコメントの書き方 タグリファレンス @deprecated @deprecatedタグは、このクラス、メソッド、プロパティを現在は使用すべきでないことを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDeprecated 構文 @deprecated deprecatedDescription deprecatedDescription -- 必須：非推奨な状態にある項目についての情報（非推奨となったバージョンや、この項目に取って代わった新しい項目など）を記述します。 @deprecatedタグは複数記述することができます。 例 /**  * @deprecated Since ver...
• @ignore
  トップページ ドックコメントの書き方 タグリファレンス @ignore @ignoreタグは、このタグが無ければ出力されるようなコード内の項目について、それをドキュメントから除外するようにJsDoc Toolkitに強制します。このタグは他の全ての機構に優先され、タグ付けされた要素がドキュメントに出力されないことが保証されます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagIgnore 構文 @ignore 例 /**  * @constructor  * @ignore  */ function Foo() {     this.bar = function() ...
• @augments
  トップページ ドックコメントの書き方 タグリファレンス @augments @augmentsタグは、ドキュメント化されたクラスが別のクラスを継承しており、そのクラスのメソッドやプロパティを使用できることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagAugments 別名 @base, @extends 構文 @augments otherClass otherClass -- 必須：このクラスの継承元クラスのネームパス 例 /**  * @constructor  */ function GeneralWriter() { } /**  * @c...
• @inner
  トップページ ドックコメントの書き方 タグリファレンス @inner @innerタグは関数が内部関数であることを示すのに使われます。内部関数は外側の関数のスコープ内で宣言され、外部から直接アクセスすることはできません。 http //code.google.com/p/jsdoc-toolkit/wiki/TagInner 構文 @inner 例 多くの場合このタグは必要ありません。通常JsDoc Toolkitはコードそのものから内部関数を認識できるからです。 /**    @constructor  */ Person = function() {     /** @inner */ ...
• @default
  トップページ ドックコメントの書き方 タグリファレンス @default @defaultタグには、クラス内のプロパティメンバのデフォルト値を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDefault 構文 @default valueDescription valueDescription -- 必須：デフォルト値についての説明 例 /** @constructor */ function Page(title) {     /**      * @default "Undefined&qu...
• @fileOverview
  トップページ ドックコメントの書き方 タグリファレンス @fileOverview @fileOverviewタグには、ファイル全体についての説明を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview 別名 @overview, @projectdescription 構文 @fileOverview fileDescription otherTags fileDescription -- 必須：ファイルの説明 otherTags -- 現在@fileOverviewと共に使用できるタグとして以下がサポートされています。：@author、@version 注意：@fileOve...
• @wiki全体から「インストール」で調べる

更新順にページ一覧表示 | 作成順にページ一覧表示 | ページ名順にページ一覧表示 | wiki内検索