Dgeniはngdoc（※1）に対応したドキュメントジェネレーターです。
ngdocに対応したドキュメントジェネレーターは他にもありますが、Dgeniは@ngdocに指定できる種類の多さや、拡張性の高さという点で他より優れています。

しかし、Dgeniは若いツールで日本語でも英語でも情報がなく、またインストールしただけでは使えないため、始めるの少し敷居が高いのが難点です。
そこで簡単にDgeniを始める方法のご紹介をしたいと思います。

インストール

npm install --save-dev grunt grunt-dgeni

GruntJS経由でDgeniの実行を行えるようにgrunt-dgeniをインストールします。

設定

Gruntfile.js

grunt.initConfig({
  dgeni: {
    options: {
      // 読み込むJavaScriptファイルのベースディレクトリ
      basePath: '/path/to'
    },
    // 読み込むJavaScriptファイル
    src: ['src/*.js'],
    // ドキュメントを出力するディレクトリ
    dest: '/path/to/build'
  },
});
grunt.loadNpmTasks('grunt-dgeni');

上記が/path/to/src/直下にJavaScriptファイルからドキュメントを設定し、/path/to/buildに出力する場合のGruntfile.jsの書き方になります。
注意点としてsrcを指定する場合は、options.basePathが必須になります。
これはDgeniの仕様でドックコメントでモジュール名が省略された場合に、options.basePathもしくは、その直下のディレクトリをモジュール名と認識するためです。
詳しくは下記のissueを確認してください。

Module name becomes two names · Issue #105 · angular/dgeni

実行

grunt dgeni

設定を終えて、上記のコマンドを実行するとドキュメントがdestに指定したディレクトリに出力されます。

デフォルトではパッケージにdgeni-markdownが使用されます。
他のパッケージを使用したり、独自のパッケージを使用する場合は

Gruntfile.js

dgeni: {
  options: {
    packages: [
      'packageName',
      '/path/to/config'
    ]
  },
},

のようにoptions.packagesを使用してください。

まとめ

いかがでしたでしょうか。
Dgeniも他のngdocに対応したドキュメントジェネレーター並みに簡単に扱えるようにしました。
恐らく、これからのAngularJSアプリケーションでドキュメントを生成する本命はDgeniになりそうなので、これを機会に皆さんも触り始めていただけると幸いです。

参考リンク

日本語情報

ngdocに対応したドキュメントジェネレーター

※1 AngularJSで使用されている独自のドックコメント

Dgeniで簡単に始めるngdocドキュメント生成

インストール

設定

実行

まとめ

参考リンク

日本語情報

ngdocに対応したドキュメントジェネレーター