Gruntのタスク一覧を表示するためのJSDocテンプレートつくってみた - Thujikun blog
Gruntのタスク一覧を表示するためのJSDocテンプレートつくってみた jsdoc3-grunt-template 最近当たり前のようにGruntで作業環境を構築するようになってきてますが、人によってタスク名とか構成がバラバラになったりで共有とか引き継ぎが大変ですよね。 わざわざREADMEにタスク一覧書いたりすることもありますが、一回書いたはいいけど更新せずに風化していくこともしばしば。 そこで、jsファイルなんだからJSDocでドキュメント作っちゃいえばいいじゃんってことでGruntに特化させたシンプルなテンプレートつくってみました。 DEMO 出来上がるファイルとしてはこちらのようなフォーマットになります。 使い方 プロジェクトのディレクトリでgrunt-jsdocのインストール 1 npm install grunt-jsdoc --save-dev テンプレートファイルを
jsdocをbootstrapできれいに生成する
Posted: February 12, 2014 / Last updated: February 12, 2014 検索してもあまり日本語の情報が出てこなかったのでメモを残しておきます。 JSDoc # JSDoc は言うまでもないですが、JavaScript のソースコードに残したコメントから自動的にリファレンスドキュメントを生成してくれるコマンドラインツール。例えばこんな感じでソースにコメントを書いておくと /** * Resolve url from `srcset` syntax http://www.w3.org/html/wg/drafts/srcset/w3c-srcset/ * @param {string} src Default URL * @param {string} srcset `srcset` argument * @param {number|undef
Jsdoc2-template-bootstrap
デモ デモはこちらから。 インストール To produce output files you must use a template to format the generated documentation. Use the -t option to specify which template you wish to use. java -jar jsrun.jar app/run.js myscripts/ -t=templates/JsDoc2-Template-Bootstrap インストールの詳細は JsDoc template documentを見てください。 拡張機能 このテンプレートは以下の拡張機能に対応しています。 Simple publish source highlight for jsdoc2 Closure annotation for JsDoc symb
JavaScriptコーダー必見！クールなJsDoc用テンプレート「JsDoc2-Template-Bootstrap」 | DOTAPON Blog
JavaScriptで大規模開発をされているみなさま、ドキュメントジェネレータは活用してますか？ ソースコードにコメントを入れておくと、自動でHTMLに仕上げてくれるアレのことです。 /** * 足し算した結果を取得します。 * * @param {Number} num1 * 足される数 * @param {Number} num2 * 足す数 * @return {Number} * 結果 */ function add(num1, num2) { return num1 + num2; } JavaScript向けのツールで有名なのが「JsDoc」。 そのまま使うと無難なデザインのHTMLが出来上がってしまいますが、テンプレート機能を使って自由に拡張できます。 そこで今日ご紹介するのが…！ JsDoc2-Template-Bootstrap いかがでしょう、Twitter Bo
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Google Code Archive - Long-term storage for Google Code Project Hosting.
JsDoc Toolkitを使う！
