接口文档生成方法及装置制造方法及图纸

本发明专利技术提供一种接口文档生成方法及装置，该接口文档生成方法包括：将源代码转换为抽象语法树，确定抽象语法树中的函数代码；解析从函数代码中提取的函数注释得到函数解析结果；根据插件配置参数从函数解析结果中获取注释信息，将注释信息和对应的函数名称输入文档模板中生成高效准确接口文档。板中生成高效准确接口文档。板中生成高效准确接口文档。

【技术实现步骤摘要】
接口文档生成方法及装置


[0001]本专利技术涉及软件开发
，具体地，涉及一种接口文档生成方法及装置。

技术介绍

[0002]在软件开发过程中，尤其在使用第三方库或者组件的过程中，需要根据第三方库或者组件的接口文档进行开发，如jquery接口文档和JavaScript实用工具库lodash的文档等。通过使用接口文档，软件开发者可以快速进行软件开发。第三方库或者组件的提供者在软件代码完成编写后需要编写接口文档，便于使用库或者组件的开发者根据接口文档进行开发。
[0003]另外一个场景是在开发较大型软件时，通常项目组成员需要协同开发，项目中的开发人员需要调用其他开发人员的开发接口，此时也需要项目开发者提供完善的接口文档。
[0004]因此不管对于库、组件还是项目组内软件开发都需要提供详细的接口文档，便于其他软件开发人员快速开发系统和应用。接口文档内容编写需要做到准确、无遗漏、详细，软件接口内容更新时接口文档自动更新。接口文档这些特点需要提供接口的开发者在软件编写完成后再编写接口文档，为实现上述接口文档特点，需要接口提供者付出大本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：将源代码转换为抽象语法树，确定所述抽象语法树中的函数代码；解析从函数代码中提取的函数注释得到函数解析结果；根据插件配置参数从所述函数解析结果中获取注释信息，将所述注释信息和对应的函数名称输入文档模板中生成接口文档。2.根据权利要求1所述的接口文档生成方法，其特征在于，从函数代码中提取函数注释包括：确定所述函数代码的函数类型：根据所述函数类型确定所述函数代码的前注释字段；从所述函数代码的前注释字段中提取函数注释。3.根据权利要求2所述的接口文档生成方法，其特征在于，从所述函数代码的前注释字段中提取函数注释包括：从函数声明代码的前注释字段中提取函数声明注释；或从变量声明节点的前注释字段中提取函数表达式注释；或从类函数代码的前注释字段中提取类函数注释。4.根据权利要求3所述的接口文档生成方法，其特征在于，从变量声明节点的前注释字段中提取函数表达式注释包括：获取函数表达式代码的变量声明节点类型，根据所述变量声明节点类型从变量声明节点的前注释字段中提取函数表达式注释。5.根据权利要求4所述的接口文档生成方法，其特征在于，获取函数表达式代码的变量声明节点类型，根据所述变量声明节点类型从变量声明节点的前注释字段中提取函数表达式注释包括：从函数表达式代码的初始化节点下获取函数表达式代码的变量声明节点类型；当所述变量声明节点类型与函数表达式对应时，从变量声明节点的前注释字段中提取函数表达式注释。6.根据权利要求1所述的接口文档生成方法，其特征在于，提取函数名称包括：确定所述函数代码的函数类型：根据所述函数类型确定所述函数代码的ID节点；从所述ID节点的姓名属性中提取函数名称。7.根据权利要求6所述的接口文档生成方法，其特征在于，根据所述函数类型确定所述函数代码的ID节点包括：从函数声明代码中确定函数声明代码的ID节点；或从函数表达式代码的变量声明节点中确定函数表达式代码的ID节点；或确定类函数代码的键值节点为类函数代码的ID节点。8.一种接口文档生成装置，其特征在于，包括：语法树转换模块，用于将源代码转换为抽象语法树，确定所述抽象语法树中的函数代码；解析模块，用于解析从函数代码中提取的函数注释得到函数解析结果；接口文档生成模块，用于根据插件配置参数从所述函数解析结果中获取注释信息，将
所述注释信息和对应的函数名称输入文档模板中生成接口文档。9.根据权利要求8所述的接口...

【专利技术属性】
技术研发人员：孟繁贵，
申请(专利权)人：中国建设银行股份有限公司，
类型：发明
国别省市：