JsDoc Toolkitを使う！内検索 / 「テンプレート」で検索した結果

• テンプレート
  トップページ カスタマイズ テンプレート このページは公式サイトの以下のページを日本語に翻訳、再構成したものです。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/）。このページの解説を利用すれば、そのテンプレートをあなた...
• カスタマイズ
  ...明します。 テンプレート JsDoc Toolikitの機能は大きくソースコードのパースを担当するコア機能とドキュメントの整形と出力を担当するテンプレート機能に分けられます。テンプレートは-tコマンドラインオプションで簡単に切り替えられ、規定の形式に則ったテンプレートを用意すれば誰でも独自構成のドキュメントを作成することができるようになっています。 ここではテンプレート・システムの仕様と新しいテンプレートを作成する方法を説明します。 プラグインの追加 プラグインはバージョン2からの新しい機能で、ソースコードのパース段階のJsDoc Toolkitの動作にある程度の独自処理を追加する仕組みを提供します。ここではプラグインの仕様と作成方法を説明します。 　 組み込みオブジェクト リファレンス JsDoc Toolkitがソースコードから...
• コンテンツ
  ...ズ テンプレート publish.js JsPlateファイル プラグインの追加 組み込みオブジェクト リファレンス 組み込みオブジェクト リファレンス JsDoc Toolkit版 ダウンロード
• publish.js
  トップページ カスタマイズ テンプレート publish.js publish.jsはテンプレート・システムの中心となるファイルで、ドキュメント出力のための実際の処理ロジックが記述されています。publish.jsはテンプレートフォルダの直下にに必ず publish.js というファイル名で存在していなくてはなりません。 目次 publish()関数 SymbolSetオブジェクトを使う Symbolオブジェクトを使う シンボルのフィルタリング JsPlateにデータを渡す ドキュメントの出力 静的ファイルのコピー publish.confプロパティ publish.js内での変数・関数宣言 publish.jsの文字エンコーディング 関連項目...
• トップページ
  ...徴のひとつは、独自のテンプレートシステムによるドキュメント表示形式の柔軟性です。テンプレートはスキンのようなもので、JsDoc Tooikitのコア機能である構文解析機能から完全に独立しています。このためユーザはテンプレートを切り替えることで、JsDoc Tooikitのソースコードに手を入れることなく独自のドキュメントスタイルを利用できるようになっています。 例えば上に挙げたソースコードを管理人が作成したテンプレートaias-frameを使って出力すると、次のようになります。 - クリックするとスクリーンショットを展開します... テンプレートなどによるJsDoc Toolkitのカスタマイズについては、こちらを参照してください。 管理人が作成したテンプレートなどをこちらからダウンロードできます。 コンテンツ トップ...
• コマンドラインオプション
  ...オプション テンプレートを指定する 出力ディレクトリを指定する ディレクトリを再帰的にたどる ソースファイルの拡張子をカスタマイズする ドックコメントの書かれていない関数を出力する コンフィグファイルを使う サンプルシェルスクリプト 関連項目 サンプルの動作環境について このページに記載されているサンプルは、以下の動作環境を想定しています。 OS：Windows (コマンドプロンプト) JRE：JRE 6 ※「%JREインストールディレクトリ%￥bin」にpathが設定済みとする カレントディレクトリ：JsDoc Toolkitのインストールディレクトリ 記述例 java -jar jsrun.jar app\run.js c \...
• JsPlateファイル
  トップページ カスタマイズ テンプレート JsPlateファイル JsPlateファイルは実際に出力されるファイルの雛形となるファイルです。これらのファイルはpublish.jsによって読み込まれ、JsDoc Toolkitがソースコードからパースした様々な情報がその中に埋め込まれます。 JsPlateファイルは「テンプレートファイル」とも呼ばれます。また「テンプレート」という単語がJsPlateファイルを指すこともあります。 目次 概要 データを受け取る JsPlateの構文 + ... + ! ... ! # ... # for ... /for if ... /if 関連項目 概要 JsPlateファイルはJSPやPH...
• メニュー
  ...ズ テンプレート publish.js JsPlateファイル プラグインの追加 組み込みオブジェクト リファレンス 組み込みオブジェクト リファレンス JsDoc Toolkit版 ダウンロード リンク JsDoc Toolkit official site JsDoc Toolkit Users Group 更新履歴 取得中です。 管理人：aiaswood ご意見・お問い合わせ等はこちらまでどうぞ 今日： - 昨日： - 合計： - - , - , - , - , - , - , - , - , - , - , - , - , -
• プラグインの追加
  ...パース処理に（結果がテンプレートに渡されるより前に実行される処理として）ユーザー独自の機能を挿入することができるようになりました。この仕組みはプラグインと呼ばれ、JsDoc Toolkitの動作をユーザーの希望にあわせて変更する便利で可搬性のある方法です。 このページは公式サイトのhttp //code.google.com/p/jsdoc-toolkit/wiki/Pluginsを元に作成しました。 インストール プラグインのインターフェースはシンプルに設計されています。プラグイン使用時のインストール作業は、プラグインファイルを app/plugins ディレクトリに保存すること－これだけです。JsDoc Toolkitを起動すると、プラグインは自動的にロード・実行されます。 管理人が作成したプラグインをこちらからダウンロードでき...
• 組み込みオブジェクト リファレンス
  ... このページではテンプレートで使用できるJsDoc Toolkitの組み込みオブジェクトとそのメンバの一部を説明します。 JsDoc Tookitのソースコードから直接作成した、より詳細なドキュメントはこちらをご覧下さい。 目次 JSDOC 名前空間 JSDOC.JsPlate クラス JSDOC.SymbolSet クラス JSDOC.Symbol クラス JSDOC.DocComment クラス JSDOC.DocTag クラス JSDOC.PluginManager 名前空間 SYS 名前空間 IO 名前空間 LOG 名前空間 Dumper名前空間 Link クラス 関数 組み込みクラスの拡張 ReqExp クラス ...
• ダウンロード
  ...は、管理人が作成したテンプレートとプラグインを公開します。 ここで公開されているプログラムの使用は商用・個人を問わず自由です。ただしそこから発生する結果について作成者は一切の責任を負わないものとします。 バグなどお気付きの点がありましたらこちらまでお願いします。 目次 テンプレート aias-frame jsdoc-ja プラグイン 一括ダウンロード additionalOptions --- いくつかのオプションを追加する browserObjects --- ブラウザ組み込みオブジェクトシンボルの自動生成 easyLink --- リンクを簡単に作成する publishSrcHilite --- ソースファイルのハイライト処理 symbolE...
• プログラムの更新履歴
  ... テンプレート aias-frame jsdoc-ja プラグイン additionalOptions browserObjects easyLink publishSrcHilite symbolExtensions tagLineBreak tagSynonyms テンプレート aias-frame 1.6.1 (2010/04/05) 説明文中に code タグで記述されたソースコードのハイライト表示機能を追加。 細かい機能追加、不具合修正など 1.6.0 (2010/01/18) 「プライベートメンバを隠す」チェックボックスを追加。 概要ページの出力機能を追加。 ...
• JsDoc Toolkit Ant Task
  ...te 使用するテンプレート名。 -t オプションに相当します。JsDoc Toolkit Ant Taskではテンプレートは"templates/"ディレクトリ直下に存在すると仮定されています。 yes outputdir 作成されたドキュメントの出力ディレクトリ。 -d オプションに相当します。注意：末尾に"/"が必要です。 yes inputdir JavaScript（やその他）の入力ファイルを含むディレクトリ source 要素がネストされていなければyes encoding 入出力ファイルの文字エンコーディング。 -e オプションに相当します。 no, デフォルトはutf-8 depth 入力ディレクトリからファイルをた...
• @example
  トップページ ドックコメントの書き方 タグリファレンス @example @exampleタグには、コンストラクタ、関数（またはメソッド）、変数の使い方を解説する小さなコードを記述できます。 http //code.google.com/p/jsdoc-toolkit/wiki/TagExample 構文 @example snippet snippet -- 必須：使用法を解説するごく小さいコード @exampleタグは複数記述できます。 例 /**  * @example  * var bleeper = makeBleep(3);  * bleeper.flop();  */ 注意 @exampleタグ...
• @event
  トップページ ドックコメントの書き方 タグリファレンス @event @eventタグは、自分と同じ名前を持つイベントが発生したときに実行することができる関数について記述します。 http //code.google.com/p/jsdoc-toolkit/wiki/TagEvent 構文 @event @eventタグの構文は@functionタグと同一です。 例 シンプルに関数をイベントとしてタグ付けできます。 /**  * @event  * @param {Boolean} clockwise  */ Cocktail.prototype.stir = function(clockwise) { } あるいは...
• @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 -- 必須：共有したいタグのグループ 注意：この指示の効果は...
• タグリファレンス
  トップページ ドックコメントの書き方 タグリファレンス このページは公式サイトのタグリファレンスを日本語に翻訳、一部を再構成したものです。 タグ一覧 @augments このクラスが継承している 基底クラス を示します。 @author ドキュメント化されたコードの作成者を示します。 @argument @paramタグの非推奨の別名です。 @borrows このクラスのメンバが他のクラスのメンバを借用していることを表します。 @class （コンストラクタに対し）クラスの説明を記述します。 @constant この項目の値を定数として扱うべきであることを示します。 @constructor 関...
• @lends
  トップページ ドックコメントの書き方 タグリファレンス @lends @lendsタグは無名オブジェクト（オブジェクトリテラル）の全メンバが、指定された名前を持つオブジェクトのメンバであるかのようにドキュメント化します。無名オブジェクトを引数にとり、そのオブジェクトのメンバを元に名前付きのクラスを生成する関数が用いられるような場合に、このタグを使いたいと思うでしょう。 http //code.google.com/p/jsdoc-toolkit/wiki/TagLends 別名 @scope 構文 @lends symbolAlias symbolAlias -- 必須：メソッド、プロパティが渡されるオブジェクト（クラス）の完全なネームパス 注意：@lendsタグを含むドックコメント...
• @wiki全体から「テンプレート」で調べる

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