需求背景

在项目中有一些数据转换工具方法如下

  • ip整形转字符串
  • 时间戳转换
  • 字典转换
    大约有30-40种
    这些都维护在java代码中,之前是共同维护文档。但随着代码升级和更新,人员变动等原因,文档会存在维护不及时,文档和代码版本 tag对应不上的情况。

遂思考采用java代码 => 文档的形式进行维护,方便其他人员去查看和使用。

开源工具

javadoc-help

方法 =>

  1. git clone https://github.com/geningxiang/javadoc-help.git
  2. 修改如下文件的如下信息
  3. 进行相关扩展

如 => 将读取到的信息存储在excel中或者mysql中
4. 通过maven 命令将插件install 到本地
5. 在项目中导入maven插件
6. 执行命令

mvn clean package -Dmaven.test.skip=true

mvn javadoc-mvn:javaDoc