[发明专利]一种自动根据字段获取注释生成接口文档的方法

说明书

一种自动根据字段获取注释生成接口文档的方法，包括：步骤一：在Java的class源文件的字段上增加对描述该字段的注释；步骤二：根据Java的class源文件的字段，使用builder设计模式，根据字段名称的命名规则，生成与字段名称相同的链式调用的方法；步骤三：根据接口文档所需字段，调用与字段名称相同的链式方法，来定义接口文档；步骤四：根据链式方法调用后的返回值来获取class源文件对应的字段，并获取该字段对应的注释，以生成接口文档的字段。解决重复定义接口字段含义的问题，以实现减少接口文档的维护成本，采用链式调用方法，支持编译时检查的特点，提前在代码编译时发现问题，避免拼写错误导致的问题，链式调用方法在开发辅助工具ide的提示下提高编码效率。

技术领域

本发明涉及接口文档处理技术领域，尤其涉及一种自动根据字段获取注释生成接口文档的方法。

背景技术

在Java开发过程中，经常会用到Java源代码文件的代码结构化解析技术，来根据Java的语法特性，把Java的文本文件解析成结构化的数据结构。

在一个接口文档中，当在不同场景下对一个表进行增删改查等操作时，修改这个表的字段也会不同，这些对同一个表执行不同操作所对应的接口都需要重复定义接口的请求参数，导致需要不断重复相同工作；同时当表的字段含义发生变化的时候，需要将所有引用到的地方都进行同步更新，造成了较高的后期维护成本。

发明内容

本发明的目的在于针对背景技术中的缺陷，提出一种自动根据字段获取注释生成接口文档的方法，解决重复定义接口字段含义的问题，以实现减少接口文档的维护成本，采用链式调用方法，基于链式调用方法支持编译时检查的特点，可以提前在代码编译时就发现问题，避免了拼写错误导致的问题，同时链式调用方法在开发辅助工具ide的提示下提高编码效率。

为达此目的，本发明采用以下技术方案：

一种自动根据字段获取注释生成接口文档的方法，包括如下步骤：

步骤一：在Java的class源文件的字段上增加对描述该字段的注释；

步骤二：根据Java的class源文件的字段，使用builder设计模式，根据字段名称的命名规则，生成与字段名称相同的链式调用的方法；

步骤三：根据接口文档所需字段，调用与字段名称相同的链式方法，来定义接口文档；

步骤四：根据链式方法调用后的返回值来获取class源文件对应的字段，并获取该字段对应的注释，以生成接口文档的字段。

优选的，在所述步骤三中，根据接口文档所需字段，调用与字段名称相同的链式方法，来定义接口文档，包括：

在每个接口所对应的方法上，使用被注释的参数来定义接口文档的实现类，所述实现类包括第一方法和第二方法，所述第一方法定义接口请求参数的字段，所述第二方法定义接口响应参数的字段。

一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现任一项上述方法的步骤。

本申请的技术方案所产生的有益效果：

1、使用java源代码上的class下面变量的注释直接作为接口文档字段的注释，避免同一个字段重复注释，解决重复定义接口字段含义的问题，以实现减少接口文档的维护成本；

2、根据class下面的变量，自动生成一套与变量名一样的支持链式调用的方法代码，在定义接口文档时直接调用链式方法来声明字段，来进行编译时的检查，链式调用方法支持编译时检查，可以提前在代码编译时就发现问题，避免了拼写错误导致的问题，同时链式调用方法在开发辅助工具ide的提示下提高编码效率。

附图说明

图1是本发明的一个实施例的自动根据字段获取注释生成接口文档方法的流程图。