jsdoc3、yuidoc, esdocを試した三田
jsdoc3がシンプル。UIが貧弱
yuidocは、UIはいいけど、@method の追加とかが手間
esdocはエラーになったので、ちゃんと確認していない。
ひとまず、jsdocのままとしている
UIテンプレートで変えられると思い、探したけど、意外となかった。
生成されたHTML
http://dev.furoom.net/jsdoc3/jsdoc3/index.html
以下を参考に
http://usejsdoc.org/
http://www38.atwiki.jp/aias-jsstyleguide2/pages/14.html
つけとくものは、以下
ファイル
@fileoverview
モジュール
@exports or @module
クラス
@constructor
@extends
→リンクにならない・・。
@interface
@implements
あたりも
メソッド
@public
@protected
@private
@abstract ※googleに無し
@override
@param
@return
@callback {RedisClient~onSubscribe} ※googleに無し
定数
@const
ちょっと試したもの
@see
@link
@fires ※googleに無し
@fileoverviewと@exportsは別のコメントブロックにしないと正しく表示されない
@callback の後は、クラス名を入れないと正しく表示されない
@linkは、反映されない。ul li の書き方は試してない。
@seeも、リンクは貼られない。。
https://github.com/nilesflow/prototype-node.js-jsdoc