自動でドキュメント吐く系のものについて考えている。

API ドキュメントでも、テスト結果だったりブログだったりでも なんでもいいんだけれど。

まずやはりテンプレートがあって、 そこに変数を当てはめられるような作りになるのは変わらないはず。

そうするとその変数はどう定義させるかというと、 やはり json や yaml という発想に至る。

複雑なフォーマットは避けたい。面倒くさくなるから。 その時、どれだけ json, yaml の簡素なフォーマットで実現できるか。

いま頭で考えてもよくわからんので、自動生成系のやつ、 ドッグフーディングしていこうと思う。

とりあえず json, yaml。 parse してテンプレートにはめる。 ここまでだと jdoc の一部を切り出した感じになる。

Erubis::Eruby.new( template ).result( [yaml|json].parse )

これをファイルに吐き出したやつが目的のドキュメント。 みたいなのが一番簡単な例。

どういうことができてどういうことができないのか。 どうことまでならできるのかとか色々見たい。