System.ArgumentOutOfRangeException: 索引和长度必须引用该字符串内的位置。 参数名: length 在 System.String.Substring(Int32 startIndex, Int32 length) 在 zhuanliShow.Bind()
【技术实现步骤摘要】
本专利技术涉及互联网,尤其是涉及一种接口文档生成方法、装置、存储介质及计算机设备。
技术介绍
1、目前,为了给游戏引擎提供二次开发的能力,并减少用户与底层复杂逻辑的交互,游戏引擎通常会接入不同的脚本语言,例如c#,lua,python,javascript等,并且把部分c++的api接口使用某种方式导出与脚本共用。在此场景下,就需要为不同的脚本语言编写相对应的api接口文档。
2、在现有技术中,api接口文档自动生成工具主要通过识别注释的方式实现api接口文档的自动生成,例如,python会使用sphinx工具,lua会使用ldoc工具等。但是,这些接口文档生成工具必须要求要有指定语言的代码和注释才能够正确生成,比如,ldoc必须识别lua代码和注释,但是,很多时候lua调用的api接口是绑定的c++中某一个函数,并没有lua代码。在这种情况下,现有的文档生成工具就无法满足根据注释生成文档的需求,从而导致api接口文档生成效率较低,并且,在生成不同脚本语言对应的api接口文档时,也需要开发人员付出较多的重复劳动,从而增加了api接口文档的维护成本。
技术实现思路
1、有鉴于此,本申请提供一种接口文档生成方法、装置、存储介质及计算机设备,主要目的在于解决接口文档生成效率较低和维护成本高的技术问题。
2、根据本专利技术的第一个方面,提供了一种接口文档生成方法,该方法包括:
3、在目标代码的前处理阶段,识别所述目标代码中的接口函数,并读取所述接口函数的
4、根据所述接口函数的函数信息和注释信息,生成目标脚本对应的中间代码,其中,所述中间代码的语言结构与所述目标脚本的语言结构相同;
5、基于所述中间代码,生成所述目标脚本的接口文档。
6、根据本专利技术的第二个方面,提供了一种接口文档生成装置,该装置包括:
7、接口函数识别模块,用于在目标代码的前处理阶段,识别所述目标代码中的接口函数,并读取所述接口函数的函数信息和注释信息;
8、中间代码生成模块,用于根据所述接口函数的函数信息和注释信息,生成目标脚本对应的中间代码,其中,所述中间代码的语言结构与所述目标脚本的语言结构相同;
9、接口文档生成模块,用于基于所述中间代码,生成所述目标脚本的接口文档。
10、根据本专利技术的第三个方面,提供了一种存储介质,其上存储有计算机程序,所述程序被处理器执行时实现上述接口文档生成方法。
11、根据本专利技术的第四个方面,提供了一种计算机设备,包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序,所述处理器执行所述程序时实现上述接口文档生成方法。
12、本专利技术提供的一种接口文档生成方法、装置、存储介质及计算机设备,首先在目标代码的前处理阶段,识别出目标代码中的接口函数,然后读取接口函数的函数信息和注释信息,进而根据接口函数的函数信息和注释信息,生成与目标脚本的语言结构相同的中间代码,最后基于中间代码,生成目标脚本的接口文档。上述方法通过对目标代码的函数信息和注释信息进行解析和组装,生成与目标脚本的语言结构相同的中间代码,然后通过中间代码生成目标脚本的接口文档,可以实现多种脚本语言的接口文档的自动生成,从而可以有效的提高接口文档的生成效率,并可以减少重复生成多种脚本语言的接口文档的劳动量,降低接口文档的开发成本和维护成本。
13、上述说明仅是本申请技术方案的概述,为了能够更清楚了解本申请的技术手段,而可依照说明书的内容予以实施,并且为了让本申请的上述和其它目的、特征和优点能够更明显易懂,以下特举本申请的具体实施方式。
本文档来自技高网...【技术保护点】
1.一种接口文档生成方法,其特征在于,所述方法包括:
2.根据权利要求1所述的方法,其特征在于,所述在目标代码的前处理阶段,识别所述目标代码中的接口函数,并读取所述接口函数的函数信息和注释信息,包括:
3.根据权利要求1所述的方法,其特征在于,所述根据所述接口函数的函数信息和注释信息,生成目标脚本对应的中间代码,包括:
4.根据权利要求1所述的方法,其特征在于,所述基于所述中间代码,生成所述目标脚本的接口文档,包括:
5.根据权利要求1至4任一项所述的方法,其特征在于,所述目标脚本包括至少一种编程语言对应的脚本程序;
6.根据权利要求1所述的方法,其特征在于,在所述根据所述接口函数的函数信息和注释信息,生成目标脚本对应的中间代码之后,所述方法还包括:
7.根据权利要求6所述的方法,其特征在于,所述方法还包括:
8.一种接口文档生成装置,其特征在于,所述装置包括:
9.一种存储介质,其上存储有计算机程序,其特征在于,所述计算机程序被处理器执行时实现权利要求1至7中任一项所述的方法的步骤。
10.一种计算机设备,包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序,其特征在于,所述计算机程序被处理器执行时实现权利要求1至7中任一项所述的方法的步骤。
...【技术特征摘要】
1.一种接口文档生成方法,其特征在于,所述方法包括:
2.根据权利要求1所述的方法,其特征在于,所述在目标代码的前处理阶段,识别所述目标代码中的接口函数,并读取所述接口函数的函数信息和注释信息,包括:
3.根据权利要求1所述的方法,其特征在于,所述根据所述接口函数的函数信息和注释信息,生成目标脚本对应的中间代码,包括:
4.根据权利要求1所述的方法,其特征在于,所述基于所述中间代码,生成所述目标脚本的接口文档,包括:
5.根据权利要求1至4任一项所述的方法,其特征在于,所述目标脚本包括至少一种编程语言对应的脚本程序;
6.根...
【专利技术属性】
技术研发人员:傅晨阳,李荣华,崔铭,冯星,方顺,
申请(专利权)人:北京渲光科技有限公司,
类型:发明
国别省市:
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。