テンプレートの変更
最後に、出力するHTMLのデザインを決定するテンプレートについて説明する。
本稿に従ってJsdoc-toolkitを実行した方はすでにお気付きになったかもしれないが、出力されたJavaScript Docは前編で紹介した画面とは異なっているはずである。
その理由は、前編で紹介した画面のテンプレートが、ダウンロードしたライブラリに梱包されているテンプレートjsdocではなく、私が一部を日本語に翻訳した改造テンプレートjsdocJpを使用しているからである。
テンプレートは.tmplという拡張子のファイルを読み込んで作られており、これを書き換えることによって、自分好みの表示やデザインに変更できる。
テンプレートはWeb上にいくつか公開されている。公式サイトのテンプレートギャラリーの中からoutlineテンプレートを紹介しよう。
outlineテンプレートを使って、本稿のサンプルスクリプトからJavaScript Docsを出力すると以下のようになる。
標準のjsdocテンプレートと比べると、かなり鮮やかな雰囲気になることが分かるだろう。
テンプレートのカスタマイズには労力が必要だが、独自に作成したJavaScriptを外部に公開するような場合ならば、テンプレートの見直しについて考えてみる価値もあるだろう。
JavaScriptによる開発の未来のために
JavaScript Doc作成ツールに関する説明は以上である。多くのシステムエンジニアの方がこれを用いることによって、より良いWebシステムを開発していただければ幸いである。
JavaScriptによる開発は、C言語やJavaなど従来のサーバ環境のプログラミングに比べて、蓄積されたノウハウが少ない。そのため、開発工数の見積もりや、WebブラウザによるJavaScriptの挙動の違い、レスポンス速度など、開発フェイズを問わず色々な場面で問題を抱えている開発現場も少なくないだろう。
しかし、そうした問題も、みんながそれぞれの知識を@ITに寄稿するなどして情報共有を深めていくことができれば、日本中でより素晴らしいWebシステムを開発できるようになる未来も、きっとそれほど遠い話ではない。
そのような希望を抱きつつ、私の今回の論稿を終了とする。
3/3 |
Index | |
JsDoc Toolkitを使いやすくカスタマイズする | |
Page1 自分好みのJsDoc Toolkitを構築する JsDoc Toolkitセットアップ 実行サポートファイルの作成 |
|
Page2 コンストラクタの設定 オプションの設定 ファイルパス指定 JavaScript Docの出力実行 |
|
Page3 テンプレートの変更 JavaScriptによる開発の未来のために |
Coding Edgeフォーラム トップページ |
- プログラムの実行はどのようにして行われるのか、Linuxカーネルのコードから探る (2017/7/20)
C言語の「Hello World!」プログラムで使われる、「printf()」「main()」関数の中身を、デバッガによる解析と逆アセンブル、ソースコード読解などのさまざまな側面から探る連載。最終回は、Linuxカーネルの中では、プログラムの起動時にはどのような処理が行われているのかを探る - エンジニアならC言語プログラムの終わりに呼び出されるexit()の中身分かってますよね? (2017/7/13)
C言語の「Hello World!」プログラムで使われる、「printf()」「main()」関数の中身を、デバッガによる解析と逆アセンブル、ソースコード読解などのさまざまな側面から探る連載。今回は、プログラムの終わりに呼び出されるexit()の中身を探る - VBAにおけるFileDialog操作の基本&ドライブの空き容量、ファイルのサイズやタイムスタンプの取得方法 (2017/7/10)
指定したドライブの空き容量、ファイルのタイムスタンプや属性を取得する方法、FileDialog/エクスプローラー操作の基本を紹介します - さらば残業! 面倒くさいエクセル業務を楽にする「Excel VBA」とは (2017/7/6)
日頃発生する“面倒くさい業務”。簡単なプログラミングで効率化できる可能性がある。本稿では、業務で使うことが多い「Microsoft Excel」で使えるVBAを紹介する。※ショートカットキー、アクセスキーの解説あり
|
|