JsDoc Toolkitを使う！内検索 / 「コマンドラインオプション」で検索した結果

• コマンドラインオプション
  トップページ ドキュメントの作成 コマンドラインオプション このページでは、コマンドラインからJsDoc Toolkitを実行しドキュメントを作成する方法について説明します。 公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/CommandlineOptionsを元に作成しました。 目次 サンプルの動作環境について 記述例 入力ファイルの指定 オプション テンプレートを指定する 出力ディレクトリを指定する ディレクトリを再帰的にたどる ソースファイルの拡張子をカスタマイズする ドックコメントの書かれていない関数を出力する コンフィグファイルを使う サンプルシェルスクリプ...
• ドキュメントの作成
  ...明します。 コマンドラインオプション 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/
• @private
  ...されません。 -p コマンドラインオプションを使用すると、privateなシンボルをドキュメントに表示することができます。 ドックコメントが一切付けられていない項目もまた、デフォルトではドキュメントに出力されません。上の例では inner と notPrivate は -a または -A コマンドラインオプションが無ければドキュメントには含まれません。 関連項目 @publicタグにより、内部関数をprivateでないかのようにドキュメントに出力することができます。
• コンテンツ
  ...成 コマンドラインオプション 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 更新履歴 取得中です。 管理人：aiaswood ご意見・お問い合わせ等はこちらまでどうぞ 今日： - 昨日： - 合計： - - , - , - , - , - , - , - , - , - , - , - ,...
• カスタマイズ
  ...。テンプレートは-tコマンドラインオプションで簡単に切り替えられ、規定の形式に則ったテンプレートを用意すれば誰でも独自構成のドキュメントを作成することができるようになっています。 ここではテンプレート・システムの仕様と新しいテンプレートを作成する方法を説明します。 プラグインの追加 プラグインはバージョン2からの新しい機能で、ソースコードのパース段階のJsDoc Toolkitの動作にある程度の独自処理を追加する仕組みを提供します。ここではプラグインの仕様と作成方法を説明します。 　 組み込みオブジェクト リファレンス JsDoc Toolkitがソースコードからパースした結果を表すSymbolオブジェクトやファイルを操作するための IO ネームスペースなど、カスタマイズに必要な組み込みオブジェクトのインターフェース情報を提供します。 ...
• JsDoc Toolkit Ant Task
  ...c Toolkitのコマンドラインオプションのほとんどを使用でき、かつAntビルドファイル内で簡単にJsDoc Toolkitを利用できます。 このページはhttp //code.google.com/p/jsdoc-toolkit-ant-task/を元に作成しました。 ここではAntそのものの説明は行いません。公式サイトやWeb上の情報を参照してください。 準備 インストール 下記URLから jsdoctoolkit-ant-task-1.0.jar をダウンロードし、適当なディレクトリに配置してください。 http //code.google.com/p/jsdoc-toolkit-ant-task/downloads/list 動作環境 JsDoc Toolkit Ant Taskの動作...
• メタタグ
  ...ます。これは -n コマンドラインオプションを一時的に有効にしているのと同じ効果です。 構文 /**#nocode+*/ .... /**#nocode-*/ 注意：この指示の効果は、ファイルの終端に達するか、 /**#nocode-*/ ドックコメントが現れるまで続きます。
• プラグインの追加
  ...olkitの起動時、コマンドラインオプションがパースされた後に発生します。ハンドラには引数としてコマンドラインオプションをプロパティに持つ無名オブジェクト（ JSDOC.opt と同じもの）が渡されるので、このオブジェクトのプロパティを操作することで処理結果に影響を与えることができます。 onFunctionCall(info) パース中のソース内で、何らかの関数またはメソッドが実行された結果として定義が生成されている箇所が見つかった場合に発生します。特定のライブラリが求めるような特殊な記法に対し、パース処理の必要に応じてドックコメントやソースコードそのものの挿入を行うタイミングとして想定されています。ハンドラには引数として以下のプロパティを持つ無名オブジェクトが渡されます。     name  &n...
• @name
  ...することもできます（コマンドラインオプションで -a を指定した場合）。そのときJsDoc Toolkit自身がネームパスの決定を行う位置に@nameタグが存在すると、競合が発生する可能性があります。 /** @name Foo */ Bar = function() { } 上のケースで -a オプションを指定した場合、完成したドキュメントには２つの要素 - Foo オブジェクトと Bar 関数 - が存在します。それはあなたが正に意図したとおりかもしれません。しかし Bar 関数をあたかも "Foo" という名前であるかのように取り扱うよう@nameタグが強制するとあなたが（誤って）考えていたとしたら、混乱してしまうかもしれません。--そうはならないのです。 関連項目 @functionタグ ...
• テンプレート
  ...トを決定する -t コマンドラインオプションではそのフォルダパスが指定されます。フォルダ内のファイルは以下の３種類に分類されます。publish.jsを除き、テンプレートフォルダ内でのこれらのファイルやディレクトリの構成、名前などは完全に作成者の自由です。 publish.js publish.jsはテンプレート・システムの中心となるファイルで、ドキュメント出力のための実際の処理ロジックが記述されています。JsDoc Toolkitはドキュメント出力時にまずこのファイルを読み込み、その内容に従ってドキュメントの作成を実行します。publish.jsはテンプレートフォルダの直下に存在していなければなりません。publish.jsの記述方法に関する詳細はこちらを参照してください。 JsPlateファイル （テンプレートファイル） ...
• タグリファレンス
  ...れらを出力するには、コマンドラインオプションで-pを指定します） @property コンストラクタのコメント内で、クラスのプロパティの情報を記述します。 @public この項目がpublicなメンバであることを示します。 @requires この項目の動作に必要なリソースを記述します。 @returns 関数の戻り値を記述します。 @see 他のリソースへのリンクを作成します。 @since この項目が有効になった特定のバージョン番号を示します。 @static クラスがインスタンス化を必要としない静的クラスであることを示します。 @throws 関数が投げる例外を記述します。 @type 項目が求める...
• トップページ
  ...成 コマンドラインオプション JsDoc Toolkit Ant Task カスタマイズ テンプレート publish.js JsPlateファイル プラグインの追加 組み込みオブジェクト リファレンス 組み込みオブジェクト リファレンス JsDoc Toolkit版 ダウンロード リンク JsDoc Toolkit official sitehttp //code.google.com/p/jsdoc-toolkit/ JsDoc Toolkit Users Grouphttp //groups.google.com/group/jsdoc-2
• ドックコメントの書き方
  ...eなメンバは -p コマンドラインオプションを指定しない限りドキュメントに出力されません。 インライン・ドックコメント インライン・ドックコメントはパラメータのデータ型をコード内に記述するドックコメントの書き方です。詳細はこちらを参照してください。 メタタグ メタタグはJsDoc Toolkitに対する命令をあらわす特殊なドックコメントです。詳細はこちらを参照してください。 関連項目 タグリファレンス ネームパス
• 組み込みオブジェクト リファレンス
  ...で、プロパティとしてコマンドラインオプションの設定値を持っています。プロパティ名はコンフィグファイルで使用されている名称と同じです。ユーザが設定した入力ファイルパスの配列は"_"プロパティにセットされています。またJsDoc Toolkitがそれをパースした実際のソースファイルのリストは、srcFilesプロパティに格納されています。 String JSDOC.VERSION JsDoc Toolkitのバージョン JSDOC.JsPlate クラス JsPlateクラスはテンプレートファイルにシンボルオブジェクトなどのデータを適用し、整形されたドキュメントを生成します。 コンストラクタ 説明 new JsPlate(templateFile) ...
• ダウンロード
  ...c Toolkitのコマンドラインオプションとして以下を追加します。これらは -D オプションによるカスタムオプションとして指定してください。 A trueを指定すると、名前が"_"から始まるメンバをprivateメンバとして扱いません。 anonymous trueを指定すると、無名関数を $anonymous という名前で出力します。（通常、無名関数は出力されません。） shortExplain trueを指定すると、生成されたシンボルの短い説明をログに出力します。 記述例 java -jar jsrun.jar app\run.js myscripts\ -D="A true" -D="anonymous true&q...
• publish.js
  ...全ファイルは -d コマンドラインオプションで指定されたディレクトリ配下に出力されることになっています。それに従った出力例は以下のようになるでしょう。 var output = myTemplate.process(mySymbol); var outDir = JSDOC.opt.d || SYS.pwd+ ../out/ ; IO.saveFile(outDir, myFilename , output); IO 名前空間のメソッドリファレンスはこちらを参照してください。 静的ファイルのコピー 静的ファイルをテンプレートディレクトリから出力ディレクトリにコピーします。下の例はcssファイルを指定された出力ディレクトリへコピーします。 IO.copyFile(SYS.pwd+ ../templates/myTemplate/s...
• @property
  トップページ ドックコメントの書き方 タグリファレンス @property JsDoc Toolkitでは、"プロパティ"と"メソッド"の扱いは若干異なります（ここでいう"メソッド"とは、ソースコード内で関数を参照しているメンバ変数のことです）。これは、通常メソッドの方がプロパティよりもAPIにとって重要であるという前提に基づいています。例えば -a オプションによって影響を受けるのはメソッドだけです。一方プロパティは、ドックコメントが書かれない限りドキュメントに出力されることはありません。 プロパティに対してドックコメントをプロパティの宣言ごとに個別に書くこともできますが、@propertyタグはより簡潔な方法を提供します - プロパティの記述をクラスの説明と同じ場所にまとめて書くの...
• プログラムの更新履歴
  トップページ ダウンロード プログラムの更新履歴 このページはダウンロードで公開されているプログラムの更新履歴一覧です。 目次 テンプレート 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/InlineDocsを日本語に翻訳、一部を再構成したものです。 インライン・ドックコメントは、関数（やコンストラクタ、メソッド）のパラメータや戻り値のデータ型をコード内への記述を可能にします。例えば以下のような場合を考えてみます。 /**   @param {String} name   @type Array  */ function getPerson(name) { } 上の例は、替わりにインライン・ドックコメントを使ってこのように書くことができます。 function getPe...
• インストール
  トップページ インストール このページでは、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) ...
• @example
  トップページ ドックコメントの書き方 タグリファレンス @example @exampleタグには、コンストラクタ、関数（またはメソッド）、変数の使い方を解説する小さなコードを記述できます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExample 構文 @example snippet snippet -- 必須：使用法を解説するごく小さいコード @exampleタグは複数記述できます。 例 /**  * @example  * var bleeper = makeBleep(3);  * bleeper.flop();  */ 注意 @exampleタグ...
• @param
  トップページ ドックコメントの書き方 タグリファレンス @param @paramタグには、関数（コンストラクタ、メソッド）のパラメータについての情報を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagParam 別名 @argument ※この別名は非推奨です。 構文 @param {paramType} paramName paramDescription paramType -- 省略可：パラメータのデータ型 paramName -- 必須：パラメータ名 paramDescription -- 省略可：パラメータの説明 例 /**  * @param userName T...
• @borrows
  トップページ ドックコメントの書き方 タグリファレンス @borrows @borrowsタグは、このクラスが元々別のクラスで定義されたメソッドまたはプロパティを保持していることを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagBorrows 別名 @inherits 構文 @borrows otherMemberName as thisMemberName otherMemberName -- 必須：借用元メンバへのネームパス thisMemberName -- 必須：借用したメンバの、このクラスにおける名前 例 /** @constructor */ function Remote...
• @version
  トップページ ドックコメントの書き方 タグリファレンス @version @versionタグには、そのコードが書かれたバージョン番号や、そのバージョンに関する情報を記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagVersion 構文 @version versionDescription versionDescription -- 必須：このコードが書かれたバージョンに関する情報 例 /**  * @class  * @version 2001 beta release  */ function Hal() {     this.sin...
• @since
  トップページ ドックコメントの書き方 タグリファレンス @since @sinceタグは、メソッドまたはプロパティがそこに記されたバージョンから追加されたことを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagSince 構文 @since versionDescription versionDescription -- 必須：バージョンについての説明 @sinceタグは複数記述できます。 例 /** @since version 1.0.1 */ function Remote() { } 関連項目 @versionタグ
• @deprecated
  トップページ ドックコメントの書き方 タグリファレンス @deprecated @deprecatedタグは、このクラス、メソッド、プロパティを現在は使用すべきでないことを示します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagDeprecated 構文 @deprecated deprecatedDescription deprecatedDescription -- 必須：非推奨な状態にある項目についての情報（非推奨となったバージョンや、この項目に取って代わった新しい項目など）を記述します。 @deprecatedタグは複数記述することができます。 例 /**  * @deprecated Since ver...
• @exports
  トップページ ドックコメントの書き方 タグリファレンス @exports @exportsタグはある要素を、コードとは異なる名前を持つ異なる要素としてドキュメントに出力できるようにします。コード内では別名で記述されている要素を、本来の名前を使ってドキュメント化したいという場合に役に立つでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExports 導入バージョン -- 2.2.0 構文 @exports codedName as documentedName codedName -- 必須：コード内で使われている名前 documentedName -- 必須：ドキュメント化するときに使用したいネームパス 例 /...
• ネームパス
  トップページ ドックコメントの書き方 ネームパス このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/NamePathsを日本語に翻訳、一部を再構成したものです。 概要 JsDoc Toolkitが作成するドキュメントにおいて、ドキュメント内のほかの場所にあるJavaScriptの値（関数、クラス、メソッドなど）への参照を記述したいケースは多くあります。そしてその場合に必要となるのは、その値へのパスを示すユニークな識別子です。ネームパス(NamePaths)はまさにそのような識別の手段を提供するもので、インスタンスメンバ、スタティック（静的）メンバ、内部変数も明確に区別できるようになっています。 例 以下に示すクラスには、"say"という...
• @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...
• @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 オブジェクトのスタティ...
• @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 */ ...
• @lends
  トップページ ドックコメントの書き方 タグリファレンス @lends @lendsタグは無名オブジェクト（オブジェクトリテラル）の全メンバが、指定された名前を持つオブジェクトのメンバであるかのようにドキュメント化します。無名オブジェクトを引数にとり、そのオブジェクトのメンバを元に名前付きのクラスを生成する関数が用いられるような場合に、このタグを使いたいと思うでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagLends 別名 @scope 構文 @lends symbolAlias symbolAlias -- 必須：メソッド、プロパティが渡されるオブジェクト（クラス）の完全なネームパス 注意：@lendsタグを含むドックコメント...
• JsPlateファイル
  トップページ カスタマイズ テンプレート JsPlateファイル JsPlateファイルは実際に出力されるファイルの雛形となるファイルです。これらのファイルはpublish.jsによって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。 JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。 目次 概要 データを受け取る JsPlateの構文 + ... + ! ... ! # ... # for ... /for if ... /if 関連項目 概要 JsPlateファイルはJSPやPH...
• @wiki全体から「コマンドラインオプション」で調べる

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