Actionのドキュメント自動生成 (LastaDoc)
LastaDoc
クラスを作ればドキュメントができる、クラスを修正すればドキュメントが変わる。
UTFluteとFreeGenを合わせて使うことで、URLとActionのマッピング表、そして、Executeメソッド の詳細が HTML のドキュメントとして自動生成されます。
LastaDocの作り方
- 1. test_document()
- [App]LastaDocTest の test_document() を実行 (JUnit)
- 2. FreeGen を叩く！
- manage.bat|sh にて 12 (freegen) を選択して実行
すると、output/lasta 配下に lastadoc-[app].html が生成されます。
URLとActionのマッピング表
URLに対して、どのActionのExecuteメソッドが対応しているかの一覧。
Executeメソッドの詳細 (HTMLスタイル)
JavaDoc や Formのプロパティ (プロパティのコメントやValidatorアノテーション含む) を表示。
Executeメソッドの詳細 (JSONスタイル)
JavaDoc や Body (RequestBodyで受け取るJSON) のプロパティ、戻りのJSONのプロパティなど。
ポイント
そのままフロントエンジニアとのコミュニケーションで使えるドキュメント(を目指す)
