gruntを使おう 〜 JavaScriptをドキュメント化するyo 〜

JavaScriptでのコーティング量も増えJavadoc同様ソースコードからドキュメントを作成する機会が増えています。そんなときに使用するのが grunt-contrib-yuidoc です。

インストール

npm install grunt-contrib-yuidoc --save-dev

Gruntfile.jsでの読み込み

grunt.loadNpmTasks('grunt-contrib-yuidoc');

使い方

grunt.initConfig({
  pkg: grunt.file.readJSON('package.json'),
  yuidoc: {
    compile: {
      name: '<%= pkg.name %>',
      description: '<%= pkg.description %>',
      version: '<%= pkg.version %>',
      url: '<%= pkg.homepage %>',
      options: {
        paths: 'path/to/source/code/',
        themedir: 'path/to/custom/theme/',
        outdir: 'where/to/save/docs/'
      }
    }
  }
});

このように定義方法は至って簡単です。引数などの基本的な使い方は Using YUIDoc を見てください。

最後に

Single-page ApplicationになりJavaScriptのコーティング量が増大しています。そのためメソッドなどはきちんとドキュメント化しましょう