タグ

jsdocとgruntに関するthujikunのブックマーク (2)

  • Gruntのタスク一覧を表示するためのJSDocテンプレートつくってみた - Thujikun blog

    Gruntのタスク一覧を表示するためのJSDocテンプレートつくってみた jsdoc3-grunt-template 最近当たり前のようにGruntで作業環境を構築するようになってきてますが、人によってタスク名とか構成がバラバラになったりで共有とか引き継ぎが大変ですよね。 わざわざREADMEにタスク一覧書いたりすることもありますが、一回書いたはいいけど更新せずに風化していくこともしばしば。 そこで、jsファイルなんだからJSDocでドキュメント作っちゃいえばいいじゃんってことでGruntに特化させたシンプルなテンプレートつくってみました。 DEMO 出来上がるファイルとしてはこちらのようなフォーマットになります。 使い方 プロジェクトのディレクトリでgrunt-jsdocのインストール 1 npm install grunt-jsdoc --save-dev テンプレートファイルを

    thujikun
    thujikun 2014/04/21
    READMEにGruntのタスク一覧を書くのがダルいので、Gruntのタスク一覧に特化したJSDocのtemplateつくったった。
  • 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

    jsdocをbootstrapできれいに生成する
  • 1