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

• @param
  ...レンス @param @paramタグには、関数（コンストラクタ、メソッド）のパラメータについての情報を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagParam 別名 @argument ※この別名は非推奨です。 構文 @param {paramType} paramName paramDescription paramType -- 省略可：パラメータのデータ型 paramName -- 必須：パラメータ名 paramDescription -- 省略可：パラメータの説明 例 /**  * @param userName The name of the user. &nbs...
• インライン・ドックコメント
  ...**   @param {String} name   @type Array  */ function getPerson(name) { } 上の例は、替わりにインライン・ドックコメントを使ってこのように書くことができます。 function getPerson( /**String*/ name) /**Array*/ { } 複数のパラメータにも使えます。 function getPerson( /**String*/ name, /**City*/ birthplace) { } 標準的なドックコメントとインライン・ドックコメントによるデータ型情報を混在させることもできます。 /**   @param name The name of the...
• @property
  ...考：このタグの構文は@paramタグとほとんど同じです。 例 下の例では、仮に -a オプションが有効であっても id プロパティはドキュメントに含まれません。 /**  * @class  */ function Person(id) {     this.id = id; } ドックコメントを付加すると、 id プロパティをドキュメントに含めることになります。 /**  * @class  */ function Person(id) {     /**      * The id of the person. &nb...
• @event
  ...  * @param {Boolean} clockwise  */ Cocktail.prototype.stir = function(clockwise) { } あるいはコード内の関数定義を参照せず、@nameタグを使うこともできます。 /**  * @name Cocktail#shake  * @event  * @param {MyEventObject} e  * @param {Boolean} [e.withIce=false]  */ イベントの参照 上に示したような名前付きドックコメントのネームパスを参照する場合、同じ名前を持つメソッドとイベントを区別できない可能性がある点に注意してください。（メソッドとイベント...
• ドックコメントの書き方
  ...  * @param {Number} num 数値  * @returns {Number} 引数で与えられた数値に1を加算した数値  */ function incrementNumber(num) {     return num + 1; } 上は関数へのドックコメントの例です。最初の行にタグなしで書かれた説明文は、関数そのものの説明です。（@descriptionタグで記述した説明文と等価です） @paramタグは引数の説明で、引数が複数ある場合は引数分列挙します。@returnsタグは戻り値の説明です。引数、戻り値が無い場合、これらを記述する必要はありません。 関数がクラスコンストラクタの場合、以下のように記述します。この記述はクラス定義とコンストラクタ関...
• タグリファレンス
  ...gument @paramタグの非推奨の別名です。 @borrows このクラスのメンバが他のクラスのメンバを借用していることを表します。 @class （コンストラクタに対し）クラスの説明を記述します。 @constant この項目の値を定数として扱うべきであることを示します。 @constructor 関数がコンストラクタであることを示します。 @constructs @lendsタグと共に記述し、関数がコンストラクタとして用いられることを示します。 @default プロパティのデフォルト値を記述します。 @deprecated この項目が既にサポートされていないことを示します。 @description 説明を記...
• トップページ
  ...  * @param {String} [str] バッファリングする文字列  * @example alert(new StringBuffer("このように").append("文字列を").append("結合します。").toString());  */ function StringBuffer(str) {     /**      * バッファされている文字列の配列      * @type String[]      * @private   ...
• 組み込みオブジェクト リファレンス
  ... データの名前。@paramタグなどデータ名定義が記述されているタグで値が設定されます。 String object.isOptional @paramタグにおいて、パラメータが省略可能ならtrueが設定されます。 String object.defaultValue @paramタグにおいて、パラメータのデフォルト値が設定されます。 メソッド 説明 String object.toString() オブジェクトの文字列表現として、 desc プロパティの値を返します。 JSDOC.PluginManager 名前空間 JSDOC.PluginManagerはプラグインの登録とイベントの発生を管理します。プラグインに...
• ダウンロード
  ...st @param @arg
• publish.js
  トップページ カスタマイズ テンプレート publish.js publish.jsはテンプレート・システムの中心となるファイルで、ドキュメント出力のための実際の処理ロジックが記述されています。publish.jsはテンプレートフォルダの直下にに必ず publish.js というファイル名で存在していなくてはなりません。 目次 publish()関数 SymbolSetオブジェクトを使う Symbolオブジェクトを使う シンボルのフィルタリング JsPlateにデータを渡す ドキュメントの出力 静的ファイルのコピー publish.confプロパティ publish.js内での変数・関数宣言 publish.jsの文字エンコーディング 関連項目...
• @public
  トップページ ドックコメントの書き方 タグリファレンス @public @publicタグは、内部変数がpublicなメンバとしてドキュメント化されるようにします。 http //code.google.com/p/jsdoc-toolkit/wiki/TagPublic 構文 @public 例 /**  * @constructor  */ function Foo() {     /** @public */     function inner() {     } } 上の例では、 inner 関数は ...
• @private
  トップページ ドックコメントの書き方 タグリファレンス @private @privateタグは、この項目が他のオブジェクトから参照できないprivateなメンバであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagPrivate 構文 @private 例 /**  * @private  * @constructor  */ function Foo() {     function inner() {     }     this.notPrivate = func...
• @namespace
  トップページ ドックコメントの書き方 タグリファレンス @namespace @namespaceタグは、あるオブジェクトが単一のグローバルな名前のもとにプロパティやメソッドの集合を保持する"名前空間"として使用されていることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagNamespace 構文 @namespace description description -- 省略可：この名前空間についての説明 例 この例では load 関数は Extensions.PluginManager のメンバとして現れます。 /**    @namespace Holds functi...
• @description
  トップページ ドックコメントの書き方 タグリファレンス @description @descriptionタグを使用して、ドキュメントに含まれるほぼ全ての要素（関数、変数、コンストラクタなど）に対し説明文を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDescription 別名 @desc 構文 @description description description -- 必須：この項目の説明 @descriptionタグは複数記述できます。 例 要素について説明文を書くことは非常に有用でありまた一般的でもありますが、このタグはごくまれにしか使われません。というのも慣例的に、ドックコメ...
• @name
  トップページ ドックコメントの書き方 タグリファレンス @name ほとんどのケースで、JsDoc Toolkitはドキュメント要素のネームパスを自ら決定することができます。この機能はユーザが必要最小限度のドックコメントを書くだけですみ、素晴らしく便利です。しかしながらネームパスが明確でないときもあり、その場合には@nameタグを使用してネームパスを明示的に指定することになります。 というものの、周辺のコードを無視し、ドックコメントを他から分離して扱うようJsDoc Toolikitに指示する@nameタグの使用には、注意が必要です。このタグはコードに現れない（または何らかの理由ではっきり示されていない）要素についての記述を可能にする、非常に強力な技術です。 http //code.google.com/p/jsdoc-toolki...
• @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 */ ...
• プログラムの更新履歴
  トップページ ダウンロード プログラムの更新履歴 このページはダウンロードで公開されているプログラムの更新履歴一覧です。 目次 テンプレート aias-frame jsdoc-ja プラグイン additionalOptions browserObjects easyLink publishSrcHilite symbolExtensions tagLineBreak tagSynonyms テンプレート aias-frame 1.6.1 (2010/04/05) 説明文中に code タグで記述されたソースコードのハイライト表示機能を追加。 細かい機能追加、不具合修正など ...
• コマンドラインオプション
  トップページ ドキュメントの作成 コマンドラインオプション このページでは、コマンドラインからJsDoc Toolkitを実行しドキュメントを作成する方法について説明します。 公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptionsを元に作成しました。 目次 サンプルの動作環境について 記述例 入力ファイルの指定 オプション テンプレートを指定する 出力ディレクトリを指定する ディレクトリを再帰的にたどる ソースファイルの拡張子をカスタマイズする ドックコメントの書かれていない関数を出力する コンフィグファイルを使う サンプルシェルスクリプ...
• @example
  トップページ ドックコメントの書き方 タグリファレンス @example @exampleタグには、コンストラクタ、関数（またはメソッド）、変数の使い方を解説する小さなコードを記述できます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExample 構文 @example snippet snippet -- 必須：使用法を解説するごく小さいコード @exampleタグは複数記述できます。 例 /**  * @example  * var bleeper = makeBleep(3);  * bleeper.flop();  */ 注意 @exampleタグ...
• 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 をダウンロードし、適当なディレクトリに配置して...
• @inner
  トップページ ドックコメントの書き方 タグリファレンス @inner @innerタグは関数が内部関数であることを示すのに使われます。内部関数は外側の関数のスコープ内で宣言され、外部から直接アクセスすることはできません。 http //code.google.com/p/jsdoc-toolkit/wiki/TagInner 構文 @inner 例 多くの場合このタグは必要ありません。通常JsDoc Toolkitはコードそのものから内部関数を認識できるからです。 /**    @constructor  */ Person = function() {     /** @inner */ ...
• プラグインの追加
  トップページ カスタマイズ プラグインの追加 JsDoc Toolokitのバージョン2から、ソースコードに対するパース処理に（結果がテンプレートに渡されるより前に実行される処理として）ユーザー独自の機能を挿入することができるようになりました。この仕組みはプラグインと呼ばれ、JsDoc Toolkitの動作をユーザーの希望にあわせて変更する便利で可搬性のある方法です。 このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/Pluginsを元に作成しました。 インストール プラグインのインターフェースはシンプルに設計されています。プラグイン使用時のインストール作業は、プラグインファイルを app/plugins ディレクトリに保存すること－これだけです。JsDoc Too...
• @exports
  トップページ ドックコメントの書き方 タグリファレンス @exports @exportsタグはある要素を、コードとは異なる名前を持つ異なる要素としてドキュメントに出力できるようにします。コード内では別名で記述されている要素を、本来の名前を使ってドキュメント化したいという場合に役に立つでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExports 導入バージョン -- 2.2.0 構文 @exports codedName as documentedName codedName -- 必須：コード内で使われている名前 documentedName -- 必須：ドキュメント化するときに使用したいネームパス 例 /...
• @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.  */ ...
• @static
  トップページ ドックコメントの書き方 タグリファレンス @static @staticタグは、その要素が、要素の属するオブジェクトのインスタンス化をしなくてもアクセス可能な静的メンバであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagStatic 構文 @static 例 var Hello = {}; /**  * @static  */ Hello.World = function() {     alert("Hello world"); } このケースでは、 World 関数は Hello オブジェクトのスタティ...
• ネームパス
  トップページ ドックコメントの書き方 ネームパス このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/NamePathsを日本語に翻訳、一部を再構成したものです。 概要 JsDoc Toolkitが作成するドキュメントにおいて、ドキュメント内のほかの場所にあるJavaScriptの値（関数、クラス、メソッドなど）への参照を記述したいケースは多くあります。そしてその場合に必要となるのは、その値へのパスを示すユニークな識別子です。ネームパス(NamePaths)はまさにそのような識別の手段を提供するもので、インスタンスメンバ、スタティック（静的）メンバ、内部変数も明確に区別できるようになっています。 例 以下に示すクラスには、"say"という...
• @borrows
  トップページ ドックコメントの書き方 タグリファレンス @borrows @borrowsタグは、このクラスが元々別のクラスで定義されたメソッドまたはプロパティを保持していることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagBorrows 別名 @inherits 構文 @borrows otherMemberName as thisMemberName otherMemberName -- 必須：借用元メンバへのネームパス thisMemberName -- 必須：借用したメンバの、このクラスにおける名前 例 /** @constructor */ function Remote...
• @function
  トップページ ドックコメントの書き方 タグリファレンス @function @functionタグは、JsDocToolkitに対し、この項目を関数として扱うように強制します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagFunction 構文 @function 例 /**  * @function  */ var paginate = paginateFactory(pages); @functionタグが無い場合、 paginate は一般的なオブジェクト変数として出力されます。プログラム実行時に paginate がどのようなデータ型を持つのか、コードの解析からは判断できないからです。 ...
• @lends
  トップページ ドックコメントの書き方 タグリファレンス @lends @lendsタグは無名オブジェクト（オブジェクトリテラル）の全メンバが、指定された名前を持つオブジェクトのメンバであるかのようにドキュメント化します。無名オブジェクトを引数にとり、そのオブジェクトのメンバを元に名前付きのクラスを生成する関数が用いられるような場合に、このタグを使いたいと思うでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagLends 別名 @scope 構文 @lends symbolAlias symbolAlias -- 必須：メソッド、プロパティが渡されるオブジェクト（クラス）の完全なネームパス 注意：@lendsタグを含むドックコメント...
• @field
  トップページ ドックコメントの書き方 タグリファレンス @field @fieldタグは、JsDocToolkitに対し、この項目を関数でないものとして扱うように強制します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagField 構文 @field 例 /**  * @field  */ var pages = function(){ } @fieldタグがなければ、変数 pages は関数として出力されます。 関連項目 @functionタグ
• @constructs
  トップページ ドックコメントの書き方 タグリファレンス @constructs @lendsタグが使われている場面で、@constructsタグは特定の関数がクラスコンストラクタであることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstructs 構文 @constructs 例 var Person = makeClass(     /**         @lends Person.prototype      */   &nb...
• @fileOverview
  トップページ ドックコメントの書き方 タグリファレンス @fileOverview @fileOverviewタグには、ファイル全体についての説明を記述することができます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview 別名 @overview, @projectdescription 構文 @fileOverview fileDescription otherTags fileDescription -- 必須：ファイルの説明 otherTags -- 現在@fileOverviewと共に使用できるタグとして以下がサポートされています。：@author、@version 注意：@fileOve...
• メタタグ
  トップページ ドックコメントの書き方 メタタグ /**# から始まるドックコメントはメタタグとして扱われ、JsDoc Toolkitに対し何らかの処理を指示する特別な構文として機能します。 このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/MetaTagsを日本語に翻訳、一部を再構成したものです。 タグの共有 「タグの共有」命令を使うと、指定された範囲のコード内に記述された全ての要素に対しタグのセットを適用できるようになります。 構文 /**#@+   anyTags  */  .... /**#@-*/ anyTags -- 必須：共有したいタグのグループ 注意：この指示の効果は...
• @see
  トップページ ドックコメントの書き方 タグリファレンス @see @seeタグは、この項目と関連する他の要素や外部リソースへのリンクを作成します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagSee 構文 @see seeDescription seeDescription -- 必須：参照先リソースの説明 例 最初の単語がドキュメント内の要素の場合、その要素へのリンクが作成されます。そうでなければ、テキストはHTMLテキストとして入力されたまま出力されます。（@linkタグは機能しないということです） /**  * @see ClassName#methodName  * @see The a ...
• JsPlateファイル
  トップページ カスタマイズ テンプレート JsPlateファイル JsPlateファイルは実際に出力されるファイルの雛形となるファイルです。これらのファイルはpublish.jsによって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。 JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。 目次 概要 データを受け取る JsPlateの構文 + ... + ! ... ! # ... # for ... /for if ... /if 関連項目 概要 JsPlateファイルはJSPやPH...
• @type
  トップページ ドックコメントの書き方 タグリファレンス @type @typeタグには、変数のデータ型、または関数（やメソッド）の戻り値のデータ型を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagType 構文 @type typeName typeName -- 必須：データ型の名前 例 /**  * @type Color  */ function getColor() { }
• @augments
  トップページ ドックコメントの書き方 タグリファレンス @augments @augmentsタグは、ドキュメント化されたクラスが別のクラスを継承しており、そのクラスのメソッドやプロパティを使用できることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagAugments 別名 @base, @extends 構文 @augments otherClass otherClass -- 必須：このクラスの継承元クラスのネームパス 例 /**  * @constructor  */ function GeneralWriter() { } /**  * @c...
• @constant
  トップページ ドックコメントの書き方 タグリファレンス @constant @constantタグは項目が定数であることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagConstant 構文 @constant 例 /**  * @constant  */ const acceleration = 9.80665;
• @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.  ...
• @ignore
  トップページ ドックコメントの書き方 タグリファレンス @ignore @ignoreタグは、このタグが無ければ出力されるようなコード内の項目について、それをドキュメントから除外するようにJsDoc Toolkitに強制します。このタグは他の全ての機構に優先され、タグ付けされた要素がドキュメントに出力されないことが保証されます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagIgnore 構文 @ignore 例 /**  * @constructor  * @ignore  */ function Foo() {     this.bar = function() ...
• @default
  トップページ ドックコメントの書き方 タグリファレンス @default @defaultタグには、クラス内のプロパティメンバのデフォルト値を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDefault 構文 @default valueDescription valueDescription -- 必須：デフォルト値についての説明 例 /** @constructor */ function Page(title) {     /**      * @default "Undefined&qu...
• インストール
  トップページ インストール このページでは、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) ...
• @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...
• @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.  */ ...
• @wiki全体から「@param」で調べる

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