数据库文档生成器

   随着各公司团队推行敏捷，项目文档越来越少（是不是对敏捷理解过激了），很多项目没有了数据库文档，针对我们项目中使用hibernate 在对象上增加注解直接生成数据库，考虑是否可以生成数据库文档，doclet提供了hibernate的文档注解但是需要将column等在注释的注解中再写一遍和字段上的注解定义重复了，因此决定自己写一个maven插件。

生成后所有表都在一个html中：



基本思想：
在po中将字段上的注释改为注解形式，并通过解析其他JPA注解最终形成数据库文档。

功能： 生成数据库文档

使用方法（注意：如果只是使用的话，不必从svn中检出此插件代码，插件已deploy到maven仓库中）

1.修改po中的注释形式 由图中下面的形式改为上面注解的形式。



2. 在bundle 的pom中加入此plugin，并添加po中可能存在的依赖的其他bundle，比如字段类型是否使用了其他bundle的枚举类型




3.执行 maven install命令

4. 在bundle的target下的daodoc.htm就是生成的数据库文档




下一步
1. 将comment注解改为类级也可用，这样数据表的含义也可自动生成了
2. 将此功能插件改造为hudson插件，在做正式版本发版时生成数据库文档并提交到svn


源代码中带有某些公司信息，需要者可以留邮箱，我再做一个版本发给大家

评论

1 楼 LinApex 2015-12-05  

[e-mail]  兄弟，能否提供下代码~？