首页/ 珠海牛角科技有限公司/ 专利详情

基于Javadoc的自动生成后端接口文档的方法及装置

基本信息

申请号 CN201710601429.X 申请日 -
公开（公告）号 CN107463376A 公开（公告）日 2017-12-12
申请公布号 CN107463376A 申请公布日 2017-12-12
分类号 G06F9/44(2006.01)I 分类 计算；推算；计数;
发明人 谭海潮 申请（专利权）人 珠海牛角科技有限公司
代理机构 北京酷爱智慧知识产权代理有限公司 代理人 珠海牛角科技有限公司
地址 519000 广东省珠海市横琴新区宝华路6号105室-15498
法律状态 -

摘要

摘要 本发明的基于Javadoc的自动生成后端接口文档的方法，具体包括以下步骤，在接口文件中定义接口信息；采用Javadoc对接口信息进行描述，描述代码的注释和接口；采用AST解析代码自动识别，识别出接口的输入参数、返回值类型、URL和异常数据；根据接口的定义和标准的Javadoc来全自动化生成接口文档。通过AST解析代码技术，根据Javadoc结合接口定义，实现所有代码改动后能够全自动化生成后端接口文档，还能根据接口数据生成前端代码，解决了过去代码和手工编写接口文档不同步的问题，不仅省去了编写接口文档的时间，还能避免接口文档和代码不同步的问题带来的返工情况，提高业务系统开发效率。