タグ

関連タグで絞り込む (0)

  • 関連タグはありません

タグの絞り込みを解除

JavaScriptとdocumentationとhowtoに関するraimon49のブックマーク (4)

  • テンプレート - JsDoc Toolkitを使う!

    テンプレート・システムの概要 JsDoc Toolkitはドキュメント出力のフォーマットを規定するための独自のテンプレート・システム"JsPlate"を持っています。JsDoc Toolkitの配布パッケージに同梱されている標準テンプレートはシンプルに"JsDoc"と名づけられています(templates/jsdoc/)。このページの解説を利用すれば、そのテンプレートをあなたが望むように改良したり、さらには自分自身でテンプレートを作成したりできるようになるはずです。 通常テンプレートは任意に名づけられた1つのフォルダ(例えば"jsdoc")にまとめられ、ドキュメント出力に使用するテンプレートを決定する -t コマンドラインオプションではそのフォルダパスが指定されます。フォルダ内のファイルは以下の3種類に分類されます。publish.jsを除き、テンプレートフォルダ内でのこれらのファイルやデ

    テンプレート - JsDoc Toolkitを使う!
  • コマンドラインオプション - JsDoc Toolkitを使う!

    サンプルの動作環境について このページに記載されているサンプルは、以下の動作環境を想定しています。 OS:Windows (コマンドプロンプト) JRE:JRE 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 ToolkitJavaで実装されたJavaScript実行環境である"Rhino"上で動作します。RhinoはJsDoc Toolkitの配布パッケージに含まれており、実行アプリケーション"jsrun"から起動されます。そしてjsrunはJsDoc Toolkitのメインスクリプトである

    コマンドラインオプション - JsDoc Toolkitを使う!
    raimon49
    raimon49 2010/09/01
    ジェネレート時のオプション解説。助かる。
  • JsDoc Toolkitによる開発効率向上を目指して (1/3)- @IT

    JavaScript開発を見直そう(前編) JsDoc Toolkitによる開発効率向上を 目指して 遠藤 太志郎 株式会社インテック ネットワーク&アウトソーシング事業部 2009/6/9 JavaScriptを使った開発で、ソースの保守性や再利用性までを視野に入れたドキュメントを残しているだろうか。Ajaxを使った高機能なWebサービスなど、JavaScriptによる開発規模は拡大している(編集部) システムエンジニアならば、JavaScriptという言葉は誰でも聞いたことがあるだろう。Webブラウザ上で動作し、主にWebブラウザのユーザーインターフェイスの向上を目的に使用されるプロトタイプベースのオブジェクト指向型スクリプト言語だ。 JavaScriptは、世に出てからしばらくの間は特にそれほど脚光を浴びるような技術ではなかったのだが、2005年にGoogleGoogle Map

    raimon49
    raimon49 2009/10/20
    JsDoc Toolkitでstaticなメソッドや組み込みクラスを拡張した時のコメント, 出力サンプル。
  • JsDoc Toolkit メモ

    JsDoc ToolkitJavaScriptソースに記述されたJavaDoc風なDOCコメントを収集しHTML化するツールである(perlで記述されているJsDocとは別物であることに注意;こちらはRhinoで記述され、必然的にJavaにもアクセスしている。Rhinoなのでこれ自体があらかたJavaScriptで記述されており、ソース自体の解読もより容易である)。 DOCコメント DOCコメントは「/**」で始まり「*/」で終わる;途中の行頭の「*」および空白系文字は無視される。DOCコメントは最初の行の説明文(省略可)と以降1つ又は複数続く、「@」で始まる「タグ」、とで構成され(各ブロックは次のタグまで又はDOCコメント末尾まで、途中の連続する空白系文字は空白1字にまとめられ、またHTMLタグの記述も可)、JsDoc Toolkitはこれらを回収分類しHTML化関数(テンプレートとも

    raimon49
    raimon49 2009/05/18
    タグリファレンスから幾つか紹介されてる
  • 1