JsDoc3と継承関係可視化プラグイン使ってドキュメント自動生成した話
背景
- レガシなビルド環境・レガシな書き方の既存のソースコードに
JsDocコメントを書いてドキュメントを自動生成することに - 本当はESDoc使いたかったけどなんかうまくいかなかった
- 書き方がレガシすぎたせい?
- あまり真面目に検証しなかったから本当は動くかも
- JsDoc3
- これは動いた
- JsDoc-Inheritance-diagram
- 継承やミックスインの可視化
つかってみた
- repository
ソースコードは特徴をおさえた架空のもの
- Prototype継承
- import/exportとかrequireとか不使用
(おそらくレガシな書き方のせいで)つらいとこ
/** * @description 何かします。 * @protected * @function * @name Derived#_someOperation * @override * @return {Boolean} 成否 */ DProto._someOperation = function () { console.log('derived'); return true; };
@function
とか@name
とか書かないとうまくメソッドと認識してもらえない@memberOf Derived#
とかも駄目