掌桥专利:专业的专利平台
掌桥专利
首页

代码注释生成方法及装置

文献发布时间:2023-06-19 10:02:03


代码注释生成方法及装置

技术领域

本申请涉及计算机技术领域,尤其涉及一种代码注释生成方法及装置。

背景技术

随着IT行业的快速发展,各种应用软件越来越复杂和庞大,复杂的软件需要开发大量的复杂的程序代码。为了增加代码的可读性以及可维护性,程序员在开发过程中会对代码进行注释,注释通常是对程序代码的解释和说明。但是注释是由程序员人工添加的,且每个程序员有自己的注释方式,不利于后来的开发或者维护人员的理解,并且当程序代码修改和变动,也需要手动修改注释,降低程序开发团队合作效率。

发明内容

本申请实施例提供了一种代码注释生成方法及装置,能够提高程序代码的可读性和可维护性,从而提高软件程序代码的开发效率。

第一方面,本申请实施例提供一种代码注释生成方法,所述方法包括:

获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;

基于所述识别关键字,从所述目标代码中获取目标内容;

基于所述目标注释方式,生成所述目标内容的注释文本;

将所述注释文本添加至所述目标代码的顶部。

可选的,确定所述目标代码的编程语言;基于所述编程语言,从所述识别关键字中确定所述目标代码的目标关键字

可选的,所述注释配置文件还包括识别范围;所述方法还包括:基于所述识别范围,确定所述目标关键字的匹配范围。

可选的,所述基于所述识别关键字,从所述目标代码中获取目标内容,包括:将所述匹配范围内的代码与所述目标关键字进行匹配;若所述第一代码与所述目标关键字匹配,则从所述第一代码中获取所述目标内容,所述匹配范围内的代码包括所述第一代码。

可选的,所述注释配置文件还可以包括第三方组件;所述方法还包括:查找所述目标代码中是否包括第一组件,所述第三方组件包括所述第一组件;若所述目标代码包括第一组件,获取所述第一组件的第一信息,所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

可选的,所述基于所述目标注释方式,生成所述目标内容的注释文本,包括:基于所述编程语言,从所述目标注释方式中选取第一注释方式,所述第一注释方法为支持所述编程语言的注释方式;基于所述第一注释方式,生成所述目标内容和/或所述第一信息的注释文本。

可选的,所述方法还包括:基于git hooks检测所述目标代码;在所述目标代码的顶部包括所述注释文本时,提交所述目标代码。

第二方面,本申请实施例提供一种代码注释生成装置,所述装置包括:

可选的,获取单元,用于获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;

所述获取单元,还用于基于所述识别关键字,从所述目标代码中获取目标内容;

生成单元,用于基于所述目标注释方式,生成所述目标内容的注释文本;

添加单元,用于将所述注释文本添加至所述目标代码的顶部。

可选的,所述装置还包括确定单元,所述确定单元,用于确定所述目标代码的编程语言;

所述确定单元,还用于基于所述编程语言,从所述识别关键字中确定所述目标代码的目标关键字。

可选的,所述注释配置文件还包括识别范围;所述确定单元,还用于基于所述识别范围,确定所述目标关键字的匹配范围。

可选的,在基于所述识别关键字,从所述目标代码中获取目标内容,所述获取单元具体用于:将所述匹配范围内的代码与所述目标关键字进行匹配;若所述第一代码与所述目标关键字匹配,则从所述第一代码中获取所述目标内容,所述匹配范围内的代码包括所述第一代码。

可选的,所述注释配置文件还可以包括第三方组件;

所述装置还包括查找单元,所述查找单元,用于查找所述目标代码中是否包括第一组件,所述第三方组件包括所述第一组件;

所述获取单元,还用于若所述目标代码包括第一组件,获取所述第一组件的第一信息,所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

可选的,所述生成单元具体用于:基于所述编程语言,从所述目标注释方式中选取第一注释方式,所述第一注释方法为支持所述编程语言的注释方式;基于所述第一注释方式,生成所述目标内容和/或所述第一信息的注释文本。

可选的,所述装置还包括检测单元和提交单元,所述检测单元,用于基于githooks检测所述目标代码;

所述提交单元,用于在所述目标代码的顶部包括所述注释文本时,提交所述目标代码。

第三方面,本申请实施例提供一种计算机设备,所述计算机设备包括处理器、存储器、通信接口以及一个或多个程序,其中,上述一个或多个程序被存储在上述存储器中,并且被配置由上述处理器执行,上述程序包括用于执行本申请实施例第一方面中任一方法所描述步骤的指令。

第四方面,本申请实施例提供了一种计算机可读存储介质,其中,上述计算机可读存储介质存储用于电子数据交换的计算机程序,其中,上述计算机程序使得计算机执行如本申请实施例第一方面中任一方法所描述的部分或全部步骤。

第五方面,本申请实施例提供了一种计算机程序产品,其中,上述计算机程序产品包括存储了计算机程序的非瞬时性计算机可读存储介质,上述计算机程序可操作来使计算机执行如本申请实施例第一方面中任一方法所描述的部分或全部步骤。该计算机程序产品可以为一个软件安装包。

本申请实施例提供一种代码注释生成方法及装置,获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;基于所述识别关键字,从所述目标代码中获取目标内容;基于所述目标注释方式,生成所述目标内容的注释文本;将所述注释文本添加至所述目标代码的顶部。本申请通过注释配置文件中识别关键字和目标注释方式,自动生成目标代码的注释文本,并将注释文本添加至该目标代码的顶部,可以提高程序代码的可读性和可维护性,从而提高了软件程序代码的开发效率。

附图说明

为了更清楚地说明本申请实施例中的技术方案,下面将对实施例中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图是本申请的一些实施例,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他的附图。

图1是本申请实施例提供的一种计算机设备的结构示意图;

图2是本申请实施例提供的一种代码注释生成方法的流程示意图;

图3是本申请实施例提供的一种注释配置文件的示意图;

图4是本申请实施例提供的一种代码的示意图;

图5a是本申请实施例提供的另一种代码的示意图;

图5b是本申请实施例提供的一种第三方组件的配置文件示意图;

图5c是本申请实施例提供的一种注释文本的示意图;

图6a是本申请实施例提供的一种代码注释生成装置的功能单元组成框图;

图6b是本申请实施例提供的另一种代码注释生成装置的功能单元组成框图;

图7是本申请实施例提供的另一种计算机设备的结构示意图。

具体实施方式

下面将结合本发明实施例中的附图,对本发明实施例中的技术方案进行清楚、成功地描述,显然,所描述的实施例是本发明一部分实施例,而不是全部的实施例。基于本发明中的实施例,本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例,都属于本发明保护的范围。

在本文中提及“实施例”意味着,结合实施例描述的特定特征、结构或特性可以包含在本发明的至少一个实施例中。在说明书中的各个位置出现该短语并不一定均是指相同的实施例,也不是与其它实施例互斥的独立的或备选的实施例。本领域技术人员显式地和隐式地理解的是,本文所描述的实施例可以与其它实施例相结合。

根据本申请实施例,提供了一种代码注释生成方法实施例,需要说明的是,在附图的流程图示出的步骤可以在诸如一组计算机可执行指令的计算机系统中执行,并且,虽然在流程图中示出了逻辑顺序,但是在某些情况下,可以以不同于此处的顺序执行所示出或描述的步骤。

本申请实施例所提供的方法实施例可以在移动终端、计算机终端或者类似的运算装置中执行。以运行在计算机终端上为例,图1是本申请实施例提供的一种计算机终端的结构示意图。如图1所示,计算机终端可以包括一个或多个(图中仅示出一个)处理器(处理器可以包括但不限于微处理器(Microcontroller Unit,MCU)或可编程逻辑器件(FieldProgrammable Gate Array,FPGA)等的处理装置)、用于存储数据的存储器、以及用于通信功能的传输装置。本领域普通技术人员可以理解,图1所示的结构仅为示意,其并不对上述电子装置的结构造成限定。例如,计算机终端还可包括比图1中所示更多或者更少的组件,或者具有与图1所示不同的配置。

存储器可用于存储应用软件的软件程序以及模块,如本申请实施例中的代码注释生成方法对应的程序指令/模块,处理器通过运行存储在存储器内的软件程序以及模块,从而执行各种功能应用以及数据处理,即实现上述的代码注释生成方法。存储器可包括高速随机存储器,还可包括非易失性存储器,如一个或者多个磁性存储装置、闪存、或者其他非易失性固态存储器。在一些实例中,存储器可进一步包括相对于处理器远程设置的存储器,这些远程存储器可以通过网络连接至计算机终端。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

传输装置用于经由一个网络接收或者发送数据。上述的网络具体实例可包括计算机终端的通信供应商提供的无线网络。在一个实例中,传输装置包括一个网络适配器(Network Interface Controller,NIC),其可通过基站与其他网络设备相连从而可与互联网进行通讯。在一个实例中,传输装置可以为射频(Radio Frequency,RF)模块,其用于通过无线方式与互联网进行通讯。

在上述运行环境下,本申请提供了如图2所示的代码注释生成方法。该方法可以应用于智能终端设备中,由智能终端设备中的处理器执行,智能终端设备可以是智能手机、平板电脑等。智能终端设备中安装有至少一个应用程序,本发明实施例并不限定应用程序的种类,可以为系统类应用程序,也可以为软件类应用程序。

请参阅图2,图2是本申请实施例提供的一种代码注释生成方法的流程示意图,应用于如图1所述的计算机设备。如图2所示,该方法包括如下步骤:

S210、获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式。

在本申请实施例中,所述注释配置文件可以放入在目标代码的文件的根目录中,并且根据各项目的要求,程序人员可以对该注释配置文件进行设置。具体地,程序人员可以手动编写该注释配置文件,并将编写好的注释配置文件存放入目标代码的文件的根目录中,通过向上查找存储目标代码的文件目录,在目标代码的根目录中获取该注释配置文件,从而可以方便快捷地获取注释配置文件对目标代码进行注释。

其中,注释配置文件可以支持多种编码语言,例如html、css、Js、vue、react、java、c语言、c++等。所述识别关键字包括一个或多个关键字,每一种编码语言的识别关键字可以不同,且每一种编码语言均可以包括一个或多个识别关键字。例如,对于编码语言是html的代码,其识别关键字可以为title、h1、h2、h3、h4、h5、h6等;对于编码语言为css的代码,其识别关键字可以为header、topnav、column、footer、body等。

进一步地,代码注释通常可以分为行注释和块注释,行注释是在注释符号后那一行代码不会被编译(显示),块注释是被块注释符号中间的代码不会被编译。在本申请实施例中,目标注释方式可以包括不同编程语言的行注释和/或块注释,不同编码语言的行注释和/或块注释的注释方式可能不同,例如,对于编码语言是html的,其通过“<!—内容-->”来进行行注释或块注释的;对于编码语言是css的代码,其通过“/*内容*/”来进行块注释,通过“//”来进行行注释。

举例说明,程序人员在配置注释配置文件时,可以配置不同编程语言的目标注释方式和识别关键字。如图3所示,图中的“Vue”表示是针对Vue编程语言的注释配置文件,图中的“JS”表示是针对JS编程语言的注释配置文件,Vue中的“symbol”表示Vue编程语言的注释方式,Vue中的“common-page-title”表示Vue编程语言的识别关键字。

S220、基于所述识别关键字,从所述目标代码中获取目标内容。

可选的,所述方法还包括:确定所述目标代码的编程语言;基于所述编程语言,从所述识别关键字中确定所述目标代码的目标关键字。

在实际应用中,不同目标代码的编码语言对应的识别关键字和目标注释方式不同,因此,需要事先确定所述目标代码的编码语言。具体地,可以通过获取目标代码的文件后缀名来确定所述目标代码的编码语言,例如,目标代码的文件名为“utils.js”,根据该文件的后缀名js可以知道该目标文件为js代码;也可以将该目标代码与各类编码语言的代码规范进行比较来确定该目标代码的编码语言,本申请实施例对此不做限定。

所述注释配置文件还包括识别范围;所述方法还包括:基于所述识别范围,确定所述目标关键字的匹配范围。

其中,在一个项目中,程序代码的数量众多,如果对所有代码都一一进行匹配来查找识别关键字,这需要花费很多的时间。因此,为了加快识别关键字查找速度,可以先基于所述识别范围确定所述识别关键字的匹配范围。例如,对于html代码,其一个页面通常分为头部、主体和底部,头部主要用于描述该代码的第三方组件以及标题;主体主要用于描述该页面的内容,主体中也可以划分为几个部分,每个部分也可以包括该部分的标题和内容;底部主要用于描述该页面的版权信息。若目标代码是用于描述某一页面的html代码,则识别范围可以为该html代码的头部代码;若目标代码是用于描述某一页面中某一部分的html代码,则识别范围可以是该html代码的主体中对应部分的内容代码。对于java代码,所述识别范围可以是函数方法,该函数方法的功能为该代码的主要功能。如图3所示,Vue中的“template”和“action”表示Vue编程语言的查找关键字的识别范围,通过在html代码的template标签中查找识别关键字common-page-title,可以加快识别关键字查找速度。

可选的,所述基于所述识别关键字,从所述目标代码中获取目标内容,包括:

将所述匹配范围内的代码与所述目标关键字进行匹配;若所述第一代码与所述目标关键字匹配,则从所述第一代码中获取所述目标内容,所述匹配范围内的代码包括所述第一代码。

其中,将所述匹配范围内的代码与所述目标关键字进行匹配,若在匹配范围内的代码中查找到目标关键字时,则将包含目标关键字的那行代码作为第一代码,从第一代码中获取对应的文本内容。具体地,当目标代码为用于描述前端的编程代码,例如html、css,可以将第一代码的文本内容作为目标内容;当目标代码为用于描述后端的编程代码,例如c++、java,可以将第一代码所处的函数方法的函数表达式作为目标内容。

例如,如图4所述,所述图4为本申请实施例提供的一种代码的示意图。如图4所示,首先获取该代码的文件名Index.vue,通过获取该代码的文件后缀名,从而确定该代码的编程语言为vue,然后从注释配置文件中获取vue代码中的识别范围为“template”标签和“action”函数方法、目标关键字为“common-page-title”属性值和“setTitle”属性值,以及目标注释方式为“/**/”。进一步地,由于该代码中为html标签,因此该代码的识别范围为“template”标签,目标关键字为“common-page-title”属性值。根据代码的识别范围“template”,可以确定所述目标关键字的匹配范围为的标签中的代码。然后将标签中的代码分别与目标关键字“common-page-title”进行匹配。若从标签中的代码匹配到目标关键字“common-page-title”,则从包含目标关键字“common-page-title”的标签中获取该标签的文本内容,即“报表中心”。

在一种可能的实施例中,所述注释配置文件还包括第三方组件;

所述方法还包括:查找所述目标代码中是否包括第一组件,所述第三方组件包括所述第一组件;若所述目标代码包括所述第一组件,获取所述第一组件的第一信息,所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

其中,程序人员在写代码时,还可能会应用一些外部和/或自定义的组件,在对目标代码生成注释时,可以生成引用组件库和第三方库中组件的注释,提高该目标代码的可读性。

具体地,在代码中引入第三方组件时,需要使用特定的语法规则来引入第三方组件,例如,在html代码和JS代码中引入第三方组件时,需要使用“import”、“export”等关键字,通过在目标代码中查找“import”关键字,可以确定目标代码中是否引入了第三方组件。若在目标代码中查找到“import”关键字时,可以获取“import”关键字后面的内容。“import”关键字后面的内容可能包括所引入第三方组件的组件名称、版本号,组件来源、组件功能中的至少一项。

举例说明,如图5a所示,图5a为本申请实施例提供的另一种代码的示意图。如图5a所示,在该Vue代码的“script”标签中引用了多个第三方组件,包括来自第三方库中的组件“qs”,以及自定义的vue组件“Datepicker”、“RrrorReload”、“BoxCard”。其中所述第三方库中的组件“qs”的配置文件如图5b所示,根据图5b可知,“qs”组件的引用的第三方库的组件名称为“qs”,版本号为“6.6.0”。

S230、基于所述目标注释方式,生成所述目标内容的注释文本。

可选的,所述基于所述目标注释方式,生成所述目标内容的注释文本,包括:

基于所述编程语言,从所述目标注释方式中选取第一注释方式,所述第一注释方法为支持所述编程语言的注释方式;基于所述第一注释方式,生成所述目标内容和/或所述第一信息的注释文本。

其中,不同目标代码的编码语言对应的注释方式不同,注释配置文件中包括多种编程语言的注释方式,即目标注释方式包括不同编程语言对应的注释方式,例如,对于图3中的注释配置文件,vue编程语言的注释方式为块注释,通过符号“/**/”实现;JS编程语言的注释方式为块注释,通过符号“/**/”实现。因此,在生成目标代码的注释之前,需要根据目标代码的编码语言,从目标注释方式中确定目标代码对应的注释方式,若注释配置文件中包括多种注释方式,则可以选择适合注释文本的注释方式。进一步地,一种编码语言可以包括行注释和块注释,在所述文本内容和/或所述第一信息超过一行时,可以选择使用块注释;在所述文本内容和/或所述第一信息为一行时,可以选择使用行注释或块注释。若注释配置文件中只包括目标代码的一种注释方式,则可以直接将注释配置文件中的注释方式确定为第一方式;若注释配置文件中包括多种注释方式,则可以从该多种注释方式中选择适合注释文本的注释方式确认为第一方式。在确认第一方式后,可以将文本内容和/或第一信息通过第一方式生成注释文本,例如,对于图4所述的代码,其代码的编程语言为vue,根据注释配置文件中的识别关键字“common-page-title”获得目标代码中的文本内容为“报表中心”,根据注释配置文件确定的第一方式为块注释,通过符号“/**/”实现,因此,生成的注释文本为“/*报表中心*/”。对于图5a所示的代码,其代码的编程语言为vue,代码中的第一组件包括来自第三方库中的组件“qs”,以及自定义的vue组件“Datepicker”、“RrrorReload”、“BoxCard”,组件“qs”的第一信息包括组件名称qs和版本号6.6.0,根据注释配置文件确定的第一方式为块注释,通过符号“/**/”实现,因此,生成的注释文本如图5c所示。

S240、将所述注释文本添加至所述目标代码的顶部。

其中,在生成目标代码的注释文本时,找到所述目标代码的第一行代码,将该注释文本插入到目标代码的第一行代码之前,从而将注释文本添加至目标代码的顶部,使得程序人员可以更加轻松地了解该代码的目的、使用的方法、使用的组件等内容,提供目标代码的可读性。

可选的,所述方法还包括:基于git hooks检测所述目标代码;在所述目标代码的顶部包括所述注释文本时,提交所述目标代码。

在本申请实施例中,对于程序人员提交的代码,可以通过git hooks对提交的代码进行注释校验,加强注释校验规范,屏蔽开发人员偷懒不写注释的问题。其中,若提交的代码的顶部没有注释,可以使用该本申请提供的方法在该代码的顶部添加注释文本;若提交的代码的顶部有注释,则直接提交。

可以看出,本申请实施例的代码注释生成方法,获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;基于所述识别关键字,从所述目标代码中获取目标内容;基于所述目标注释方式,生成所述目标内容的注释文本;将所述注释文本添加至所述目标代码的顶部。本申请通过注释配置文件中识别关键字和目标注释方式,自动生成目标代码的注释文本,并将注释文本添加至该目标代码的顶部,可以提高程序代码的可读性和可维护性,从而提高了软件程序代码的开发效率。

上述主要从方法侧执行过程的角度对本申请实施例的方案进行了介绍。可以理解的是,电子设备为了实现上述功能,其包含了执行各个功能相应的硬件结构和/或软件模块。本领域技术人员应该很容易意识到,结合本文中所提供的实施例描述的各示例的单元及算法步骤,本申请能够以硬件或硬件和计算机软件的结合形式来实现。某个功能究竟以硬件还是计算机软件驱动硬件的方式来执行,取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用使用不同方法来实现所描述的功能,但是这种实现不应认为超出本申请的范围。

本申请实施例可以根据上述方法示例对电子设备进行功能单元的划分,例如,可以对应各个功能划分各个功能单元,也可以将两个或两个以上的功能集成在一个处理单元中。上述集成的单元既可以采用硬件的形式实现,也可以采用软件功能单元的形式实现。需要说明的是,本申请实施例中对单元的划分是示意性的,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式。

请参阅图6a,图6a是本申请实施例提供的一种代码注释生成装置600的功能单元组成框图,如图6a所示,该装置600包括获取单元610、生成单元620和添加单元630,其中,

获取单元610,用于获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;

所述获取单元610,还用于基于所述识别关键字,从所述目标代码中获取目标内容;

生成单元620,用于基于所述目标注释方式,生成所述目标内容的注释文本;

添加单元630,用于将所述注释文本添加至所述目标代码的顶部

可选的,如图6b所示,是本申请实施例提供的另一种代码注释生成装置600的功能单元组成框图,所述装置600还包括:确定单元640,所述确定单元640,用于确定所述目标代码的编程语言;

所述确定单元640,还用于基于所述编程语言,从所述识别关键字中确定所述目标代码的目标关键字。

可选的,所述注释配置文件还包括识别范围;所述确定单元640,还用于基于所述识别范围,确定所述目标关键字的匹配范围。

可选的,在基于所述识别关键字,从所述目标代码中获取目标内容,所述获取单元610具体用于:将所述匹配范围内的代码与所述目标关键字进行匹配;若所述第一代码与所述目标关键字匹配,则从所述第一代码中获取所述目标内容,所述匹配范围内的代码包括所述第一代码。

可选的,所述注释配置文件还可以包括第三方组件;

所述装置600还包括查找单元650,所述查找单元650,用于查找所述目标代码中是否包括第一组件,所述第三方组件包括所述第一组件;

所述获取单元610,还用于若所述目标代码包括第一组件,获取所述第一组件的第一信息,所述第一信息包括组件名称、版本号、组件来源、组件功能中的至少一项。

可选的,所述生成单元620具体用于:基于所述编程语言,从所述目标注释方式中选取第一注释方式,所述第一注释方法为支持所述编程语言的注释方式;基于所述第一注释方式,生成所述目标内容和/或所述第一信息的注释文本。

可选的,所述装置600还包括检测单元660和提交单元670,所述检测单元660,用于基于git hooks检测所述目标代码;

所述提交单元670,用于在所述目标代码的顶部包括所述注释文本时,提交所述目标代码。

可以看出,本申请实施例提供一种代码注释生成装置,获取单元获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式,以及基于所述识别关键字,从所述目标代码中获取目标内容;生成单元基于所述目标注释方式,生成所述目标内容的注释文本;添加单元将所述注释文本添加至所述目标代码的顶部。本申请通过注释配置文件中识别关键字和目标注释方式,自动生成目标代码的注释文本,并将注释文本添加至该目标代码的顶部,可以提高程序代码的可读性和可维护性,从而提高了软件程序代码的开发效率。

可以理解的是,本申请实施例的代码注释生成装置的各程序模块的功能可根据上述方法实施例中的方法具体实现,其具体实现过程可以参照上述方法实施例的相关描述,此处不再赘述。

请参阅图7,图7是本申请实施例提供的另一种计算机设备的结构示意图,如7图所示,该计算机设备包括存储器、通信接口和处理器,其中,该计算机设备还可以包括通信总线,所述处理器、通信接口和存储器之间可以通过总线相互连接。

其中,上述处理器,用于执行所述存储器上所存放的程序时,实现以下步骤:

获取目标代码的注释配置文件,所述注释配置文件包括识别关键字和目标注释方式;

基于所述识别关键字,从所述目标代码中获取目标内容;

基于所述目标注释方式,生成所述目标内容的注释文本;

将所述注释文本添加至所述目标代码的顶部。

进一步地,处理器可以是一个通用中央处理器(Central Processing Unit,CPU)或多个CPU,单块或多块图形处理器(Graphics Processing Unit,GPU),微处理器,特定应用集成电路(Application Specific Integrated Circuit,ASIC),或一个或多个用于控制本发明方案程序执行的集成电路。

存储器可以是只读存储器(Read Only Memory,ROM)或可存储静态信息和指令的其他类型的静态存储设备,随机存取存储器(Random Access Memory,RAM)或者可存储信息和指令的其他类型的动态存储设备,也可以是电可擦可编程只读存储器(ElectricallyErasable Programmable Read-Only Memory,EEPROM)、只读光盘(Compact Disc Read-Only Memory,CD-ROM)或其他光盘存储、光碟存储(包括压缩光碟、激光碟、光碟、数字通用光碟、蓝光光碟等)、磁盘存储介质或者其他磁存储设备、或者能够用于携带或存储具有指令或数据结构形式的期望的程序代码并能够由计算机存取的任何其他介质,但不限于此。

在一些示例中,存储器可以是独立存在,通信接口和通信总线与处理器相连接。存储器也可以和处理器集成在一起。通信总线在上述组件之间传送信息。

本申请实施例还提供一种计算机存储介质,其中,该计算机存储介质存储用于电子数据交换的计算机程序,该计算机程序使得计算机执行如上述方法实施例中记载的任一方法的部分或全部步骤。

本申请实施例还提供一种计算机程序产品,上述计算机程序产品包括存储了计算机程序的非瞬时性计算机可读存储介质,上述计算机程序可操作来使计算机执行如上述方法实施例中记载的任一方法的部分或全部步骤。该计算机程序产品可以为一个软件安装包。

需要说明的是,对于前述的各方法实施例,为了简单描述,故将其都表述为一系列的动作组合,但是本领域技术人员应该知悉,本申请并不受所描述的动作顺序的限制,因为依据本申请,某些步骤可以采用其他顺序或者同时进行。其次,本领域技术人员也应该知悉,说明书中所描述的实施例均属于优选实施例,所涉及的动作和模块并不一定是本申请所必须的。

在上述实施例中,对各个实施例的描述都各有侧重,某个实施例中没有详述的部分,可以参见其他实施例的相关描述。

在本申请所提供的几个实施例中,应该理解到,所揭露的装置,可通过其它的方式实现。例如,以上所描述的装置实施例仅仅是示意性的,例如上述单元的划分,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式,例如多个单元或组件可以结合或者可以集成到另一个系统,或一些特征可以忽略,或不执行。另一点,所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些接口,装置或单元的间接耦合或通信连接,可以是电性或其它的形式。

上述作为分离部件说明的单元可以是或者也可以不是物理上分开的,作为单元显示的部件可以是或者也可以不是物理单元,即可以位于一个地方,或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。

另外,在本申请各个实施例中的各功能单元可以集成在一个处理单元中,也可以是各个单元单独物理存在,也可以两个或两个以上单元集成在一个单元中。上述集成的单元既可以采用硬件的形式实现,也可以采用软件功能单元的形式实现。

上述集成的单元如果以软件功能单元的形式实现并作为独立的产品销售或使用时,可以存储在一个计算机可读取存储器中。基于这样的理解,本申请的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的全部或部分可以以软件产品的形式体现出来,该计算机软件产品存储在一个存储器中,包括若干指令用以使得一台计算机设备(可为个人计算机、计算机设备或者网络设备等)执行本申请各个实施例上述方法的全部或部分步骤。而前述的存储器包括:U盘、只读存储器(ROM,Read-Only Memory)、随机存取存储器(RAM,Random Access Memory)、移动硬盘、磁碟或者光盘等各种可以存储程序代码的介质。

本领域普通技术人员可以理解上述实施例的各种方法中的全部或部分步骤是可以通过程序来指令相关的硬件来完成,该程序可以存储于一计算机可读存储器中,存储器可以包括:闪存盘、ROM、RAM、磁盘或光盘等。

以上对本申请实施例进行了详细介绍,本文中应用了具体个例对本申请的原理及实施方式进行了阐述,以上实施例的说明只是用于帮助理解本申请的方法及其核心思想;同时,对于本领域的一般技术人员,依据本申请的思想,在具体实施方式及应用范围上均会有改变之处,综上所述,本说明书内容不应理解为对本申请的限制。

相关技术
  • 代码注释文档的生成方法、装置、电子设备及存储介质
  • 代码注释生成方法及装置
技术分类

06120112390011