代码注释生成方法、装置、设备、介质和程序产品与流程

1.本公开涉及人工智能领域，更具体地涉及一种代码注释生成方法、装置、设备、介质和程序产品。


背景技术：

2.为了增加代码的可读性和可维护性，通常需要对代码进行注释，注释通常是对程序代码的解释和说明。现有的代码注释方法通常分为人工注释和自动注释。其中，人工注释由技术人员手动进行代码注释，该方法费时费力，且由于每个技术人员的注释习惯不同，因此无法对注释内容进行规范，不利于其他技术人员进行后续理解。自动注释通常采用单一方法进行注释，存在注释不准确，注释格式不规范，对于部分代码无法进行注释的问题。


技术实现要素：

3.鉴于上述问题，本公开提供了提高代码注释生成成功率的代码注释生成方法、装置、设备、介质和程序产品。
4.根据本公开的第一个方面，提供了一种代码注释生成方法，包括：从多种注释方式确定目标注释方式；基于目标注释方式重复对待注释代码进行注释，得到多份注释初稿；计算任意两份注释初稿之间的相似度，得到多个相似度值；根据多个相似度值确定每份注释初稿的通用值；比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。
5.根据本公开的实施例，从多种注释方式确定目标注释方式，包括：基于预设的优先级依次对待注释代码执行注释方式；将可以得到注释内容的注释方式确定为目标注释方式。
6.根据本公开的实施例，基于预设的优先级依次对待注释代码执行多种注释方式，包括：基于待注释代码的依赖关系来获取第一注释内容；响应于未获取到第一注释内容，执行基于待注释代码的函数名和变量类型的注释方式来获取第二注释内容；响应于未获取到第二注释内容，执行基于待注释代码的类方法调用关系的注释方式来获取第三注释内容；响应于未获取到第三注释内容，执行基于待注释代码的语义内容的注释方式来获取第四注释内容。
7.根据本公开的实施例，基于待注释代码的依赖关系来获取第一注释内容，包括：筛选待注释代码中符合稀有规则的代码；响应于筛选后的代码中存在依赖包，在预设的文档库中获取依赖包注释，得到第一注释内容；其中，筛选待注释代码中符合稀有规则的代码包括：统计每一代码的出现频次，将出现频次低于阈值的代码确定为符合稀有规则的代码；预设的文档库包含依赖包的官方注释。
8.根据本公开的实施例，获取依赖包的注释，还包括：统计依赖包注释的字数；在字数超过阈值的情况下，执行注释缩写。
9.根据本公开的实施例，基于待注释代码的函数名和变量类型获取第二注释内容，包括：基于编译器进行待注释代码中函数名和变量类型的识别，得到第二注释内容；其中，
基于编译器进行待注释代码识别还包括：确定待注释代码所使用的编程语言；基于编程语言将待注释代码输入至对应的编译器中；其中，每一编译器对应一种编程语言。
10.根据本公开的实施例，基于待注释代码的类方法调用关系获取第三注释内容，包括：基于待注释代码的类方法调用关系构建调用关系结构树；在预先构建的关系结构库中查找同构关系结构树；将同构关系结构树的代码注释作为第三注释内容；其中，预先构建的关系结构库包含多个结构树以及与每一结构树对应的注释。
11.根据本公开的实施例，基于待注释代码的语义内容获取第四注释内容，包括：在预先构建的算法注释库中查找符合条件的代码；其中，符合条件的代码为满足与待注释代码内容的相似值的代码；将符合条件的代码注释作为第四注释内容。
12.根据本公开的实施例，预先构建的算法注释库的构建方法，包括：定期爬取网络中的开源代码及其注释；统计开源代码的出现频率，基于出现频率确定常用代码；响应于算法注释库中不包含该常用代码，将常用代码及其注释保存至算法注释库。
13.根据本公开的实施例，根据多个相似度值确定每个注释初稿的通用值，包括：计算该注释初稿与其余注释初稿之间相似度值的平均值，平均值即为该注释初稿的通用值。
14.本公开的第二方面提供了一种代码注释生成装置，包括：目标方式确定模块，用于从多种注释方式确定目标注释方式；重复注释模块，用于基于目标注释方式重复对待注释代码进行注释，得到多份注释初稿；相似计算模块，用于计算任意两份注释初稿之间的相似度，得到多个相似度值；通用值计算模块，用于根据多个相似度值确定每份注释初稿的通用值；注释终稿确定模块，用于比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。
15.本公开的第三方面提供了一种电子设备，包括：一个或多个处理器；存储器，用于存储一个或多个程序，其中，当所述一个或多个程序被所述一个或多个处理器执行时，使得一个或多个处理器执行上述代码注释生成方法。
16.本公开的第四方面还提供了一种计算机可读存储介质，其上存储有可执行指令，该指令被处理器执行时使处理器执行上述代码注释生成方法。
17.本公开的第五方面还提供了一种计算机程序产品，包括计算机程序，该计算机程序被处理器执行时实现上述代码注释生成方法。
附图说明
18.通过以下参照附图对本公开实施例的描述，本公开的上述内容以及其他目的、特征和优点将更为清楚，在附图中：
19.图1示意性示出了根据本公开实施例的代码注释生成方法、装置、设备、介质和程序产品的应用场景图；
20.图2示意性示出了根据本公开实施例的代码注释生成方法的流程图；
21.图3示意性示出了根据本公开实施例的基于预设的优先级依次对待注释代码执行多种注释方式的流程图；
22.图4示意性示出了根据本公开实施例的基于待注释代码的依赖关系来获取第一注释内容的流程图；
23.图5示意性示出了根据本公开实施例的基于待注释代码的依赖关系来获取第一注
释内容的流程图；
24.图6示意性示出了根据本公开实施例的基于待注释代码的语义内容获取第四注释内容的流程图；
25.图7示意性示出了根据本公开实施例的预先构建的算法注释库的构建方法的流程图；
26.图8示意性示出了根据本公开实施例的代码注释生成装置的结构框图；以及
27.图9示意性示出了根据本公开实施例的适于实现代码注释生成方法的电子设备的方框图。
具体实施方式
28.以下，将参照附图来描述本公开的实施例。但是应该理解，这些描述只是示例性的，而并非要限制本公开的范围。在下面的详细描述中，为便于解释，阐述了许多具体的细节以提供对本公开实施例的全面理解。然而，明显地，一个或多个实施例在没有这些具体细节的情况下也可以被实施。此外，在以下说明中，省略了对公知结构和技术的描述，以避免不必要地混淆本公开的概念。
29.在此使用的术语仅仅是为了描述具体实施例，而并非意在限制本公开。在此使用的术语“包括”、“包含”等表明了所述特征、步骤、操作和/或部件的存在，但是并不排除存在或添加一个或多个其他特征、步骤、操作或部件。
30.在此使用的所有术语(包括技术和科学术语)具有本领域技术人员通常所理解的含义，除非另外定义。应注意，这里使用的术语应解释为具有与本说明书的上下文相一致的含义，而不应以理想化或过于刻板的方式来解释。
31.在本公开的技术方案中，所涉及的用户个人信息的收集、存储、使用、加工、传输、提供、公开和应用等处理，均符合相关法律法规的规定，采取了必要保密措施，且不违背公序良俗。
32.在本公开的技术方案中，在获取或采集用户个人信息之前，均获取了用户的授权或同意。
33.在使用类似于“a、b和c等中至少一个”这样的表述的情况下，一般来说应该按照本领域技术人员通常理解该表述的含义来予以解释(例如，“具有a、b和c中至少一个的系统”应包括但不限于单独具有a、单独具有b、单独具有c、具有a和b、具有a和c、具有b和c、和/或具有a、b、c的系统等)。
34.本公开的实施例提供了一种代码注释生成方法，包括：从多种注释方式确定目标注释方式；基于目标注释方式重复对待注释代码进行注释，得到多份注释初稿；计算任意两个注释初稿之间的相似度，得到多个相似度值；根据多个相似度值确定每个注释初稿的通用值；比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。
35.图1示意性示出了根据本公开实施例的代码注释生成方法、装置、设备、介质和程序产品的应用场景图。
36.如图1所示，根据该实施例的应用场景100可以包括第一终端设备101、第二终端设备102、第三终端设备103、网络104和服务器105。网络104用以在终端设备101、102、103和服务器105之间提供通信链路的介质。网络104可以包括各种连接类型，例如有线、无线通信链
路或者光纤电缆等等。
37.用户可以使用第一终端设备101、第二终端设备102、第三终端设备103通过网络104与服务器105交互，以接收或发送消息等。第一终端设备101、第二终端设备102、第三终端设备103上可以安装有各种通讯客户端应用，例如购物类应用、网页浏览器应用、搜索类应用、即时通信工具、邮箱客户端、社交平台软件等(仅为示例)。
38.第一终端设备101、第二终端设备102、第三终端设备103可以是具有显示屏并且支持网页浏览的各种电子设备，包括但不限于智能手机、平板电脑、膝上型便携计算机和台式计算机等等。
39.服务器105可以是提供各种服务的服务器，例如对用户利用第一终端设备101、第二终端设备102、第三终端设备103所浏览的网站提供支持的后台管理服务器(仅为示例)。后台管理服务器可以对接收到的用户请求等数据进行分析等处理，并将处理结果(例如根据用户请求获取或生成的网页、信息、或数据等)反馈给终端设备。
40.需要说明的是，本公开实施例所提供的代码注释生成方法一般可以由服务器105执行。相应地，本公开实施例所提供的代码注释生成装置一般可以设置于服务器105中。本公开实施例所提供的代码注释生成方法也可以由不同于服务器105且能够与第一终端设备101、第二终端设备102、第三终端设备103和/或服务器105通信的服务器或服务器集群执行。相应地，本公开实施例所提供的代码注释生成装置也可以设置于不同于服务器105且能够与第一终端设备101、第二终端设备102、第三终端设备103和/或服务器105通信的服务器或服务器集群中。
41.应该理解，图1中的终端设备、网络和服务器的数目仅仅是示意性的。根据实现需要，可以具有任意数目的终端设备、网络和服务器。
42.在一些实施例中，代码注释可以包含文件类的注释，函数的注释，行的注释。其中，在文件类的注释中，一个文件通常只有一个类，需对该类进行注释，以python语言为例，扫描关键词为class，每个函数需要一个注释，扫描关键词为def。而行的注释通常在调用使用较少的特殊函数，或是较为复杂的语句时进行注释，通过调用的频次和行的字符长度进行扫描。
43.以下将基于图1描述的场景，通过图2～图6对公开实施例的代码注释生成方法进行详细描述。
44.图2示意性示出了根据本公开实施例的代码注释生成方法的流程图。
45.如图2所示，该实施例的代码注释生成方法包括操作s210～操作s250。
46.在操作s210，从多种注释方式确定目标注释方式。
47.在一些实施例中，提供多种注释方式用于实现代码注释，用户可以从多种注释方式中确定其中一种注释方式作为目标注释方式，进行后续操作。其中，从多种注释方式确定目标注释方式，包括：基于预设的优先级依次对待注释代码执行注释方式；将可以得到注释内容的注释方式确定为目标注释方式。
48.其中，基于每种注释方式生成的注释内容的准确性和正确性对多种注释方式进行优先级预设，尽可能确保目标注释方式提供的注释内容具有较高的准确性和正确性。
49.相较于单一注释方式，采用多种注释方式可以从不同维度对待注释代码进行分析。对待注释代码进行多维度分析，可以有效提高代码注释的成功率，使得待注释代码总能
通过本公开的代码注释生成方法得到代码注释。相应的，由于本公开的代码注释生成方法可以从对多个维度进行待注释代码分析，因此，该代码注释生成方法具有较好的通用性，可以广泛应用于不同类型的待注释代码，并选择与待注释代码更加匹配的目标注释方式进行注释，有效提高注释方法与代码类型的匹配程度，从而提高代码注释的精确度。
50.在操作s220，基于目标注释方式重复对待注释代码进行注释，得到多份注释初稿。
51.在一些实施例中，由于自然语言处理模型通常使用随机种子来探索不同的可能性，为了确保答案具有创造性或较多的信息量，技术人员通常不会完全控制随机种子。因此，需重复采用目标注释方式对待注释代码进行注释，得到多份不同的注释初稿。其中，重复的次数可以由用户根据实际情况设置，本公开在此不做具体限定。
52.在操作s230，计算任意两份注释初稿之间的相似度，得到多个相似度值。
53.在一些实施例中，基于预设的模型对任意两份初稿间进行相似度比较，得到多个相似度值。例如，经过操作s220，得到初稿a、初稿b、初稿c和初稿d。其中，初稿a分别与初稿b、初稿c、初稿d进行相似度比较并得到相应的相似度值β
a-b
、β
a-c
、β
a-d
，初稿b分别与初稿c、初稿d进行相似度比较并得到相应的相似度值β
b-c
、β
b-d
，依次类推，得到多个相似度值。
54.在操作s240，根据多个相似度值确定每份注释初稿的通用值。
55.在一些实施例中，通过计算每份注释初稿与其余注释初稿之间的多个相似度值的平均值，确定每份注释初稿的通用值。
56.例如，在操作s230中所述的初稿a的通用值为δa＝(β
a-b
+β
a-c
+β
a-d
)/n，初稿b的通用值为δb＝(β
a-b
+β
b-c
+β
b-d
)/n，其中，n为初稿总数。以此类推，分别计算初稿a、初稿b、初稿c和初稿d的通用值。
57.在操作s250，比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。
58.通用值反应的是该注释初稿的通用程度，当该注释初稿的通用值较高，说明该注释初稿与多份注释初稿相似，具有更好的通用性，也更容易与代码内容相匹配。因此，在本公开实施例中，通过计算注释初稿的通用值，确定通用性最高的注释初稿，并将该注释初稿作为注释终稿插入在代码中，作为这一代码的注释。
59.本公开实施例的代码注释生成方法提供多种注释方式，用户可从多种注释方式中确定目标注释方式，用于对待注释代码进行注释。即本公开实施例中，提供了多种注释方式作为代码注释的选项，通过对代码进行多维度分析得到注释初稿，有效提高代码注释的成功率。此外，本公开实施例还提供了根据相似度对注释初稿进行通用值计算，并选择通用值最高的注释初稿作为代码的注释终稿，使得注释终稿与代码之间的适配性更高，进一步提高代码注释的准确度。
60.在一些实施例中，本公开提供的方案还包括：若待注释代码中的部分代码包含原注释，则将该部分代码的注释终稿与原注释进行相似性比较，若相似性比较的值低于预设阈值，则将该部分代码的原注释替换为注释终稿。其中，预设阈值通常为百分之八十，技术人员也可以根据实际应用需求对预设阈值进行相应调整，在此不作限定。
61.应当理解的是，对于待注释代码中包含的原注释，技术人员无法确定该注释的正确性与规范性，因此，本公开提出利用注释终稿对原注释进行相似性比较，可以有效判断原注释是否符合要求，以确保代码注释的准确性。当原注释与注释终稿的相似性比较的值满
足阈值时，说明原注释的正确性和规范性较高，可以继续沿用原注释。当原注释与注释终稿的相似性比较的值不满足阈值时，说明原注释的正确性和规范性较低，此时则利用注释终稿对原注释进行替换，以保证注释的正确性和规范性。
62.在一些实施例中，由算法模型实现相似性比较。本公开采用的算法模型是基于transformer的注意力机制生成的自回归模型，该算法模型的训练方法分为两个步骤：预训练和微调。预训练是指在大规模的未标注文本上对模型进行无监督的训练。在预训练过程中，模型学习到了自然语言中的语法、语义和逻辑等信息，这些信息可以被用于下游任务的处理。在预训练完整后，结合模型应用的具体的下游任务对模型进行微调，微调过程中需要选择合适的优化器和学习率来更新模型参数，同时需要调整训练数据的批量大小和训练轮数等超参数，以达到最佳的性能。在预训练阶段，本公开利用从互联网中爬取的开源代码及其注释对该算法模型的参数进行调整，使得调整后的算法模型学习到的语法、语义和逻辑等信息更符合本公开的应用场景，有效提高该算法模型与本公开应用场景的匹配度，提高代码注释的精度。在微调阶段，该算法模型引入零样本学习(zero-shot)算法，该算法基于任务描述(description)和任务提示(prompt)对执行下游任务。基于不同的任务描述和任务提示，该算法模型可以执行多种下游任务。此时，该算法模型执行的下游任务为相似性比较任务，相应的，此时输入的任务描述和任务提示内容均为相似性比较相关内容。
63.图3示意性示出了根据本公开实施例的基于预设的优先级依次对待注释代码执行多种注释方式的流程图。
64.如图3所示，该实施例的代码注释生成方法包括操作s310～操作s340。
65.在操作s310，基于待注释代码的依赖关系来获取第一注释内容。
66.在操作s320，响应于未获取到第一注释内容，执行基于待注释代码的函数名和变量类型的注释方式来获取第二注释内容。
67.在操作s330，响应于未获取到第二注释内容，执行基于待注释代码的类方法调用关系的注释方式来获取第三注释内容。
68.在操作s340，响应于未获取到第三注释内容，执行基于待注释代码的语义内容的注释方式来获取第四注释内容。
69.在一些实施例中，基于注释内容的精确度对注释方式进行优先级排序。其中，注释内容的正确度由高到低依次为：第一注释内容、第二注释内容、第三注释内容和第四注释内容。基于优先级依次对待注释代码执行多种注释方式，在得到注释内容的基础上进一步保证注释内容的正确性和准确性。
70.图4示意性示出了根据本公开实施例的基于待注释代码的依赖关系来获取第一注释内容的流程图。
71.如图4所示，该实施例的代码注释生成方法包括操作s410～操作s420。
72.在操作s410，筛选待注释代码中符合稀有规则的代码。
73.其中，筛选待注释代码中符合稀有规则的代码包括：统计每一代码的出现频次，将出现频次低于阈值的代码确定为符合稀有规则的代码。
74.在操作s420，响应于筛选后的代码中存在依赖包，在预设的文档库中获取所述依赖包注释，得到所述第一注释内容。
75.其中，预设的文档库包含依赖包的官方注释。
76.在一些实施例中，待注释代码中会包含多个代码以及依赖包，部分基础代码的出现频率较高，这些基础代码的含义简单且被本领域技术人员悉知。因此，在进行代码注释时，可以跳过基础代码对其他代码进行注释，以便于节约服务器资源以及内存空间。例如，print作为一种输出函数，在代码中的出现频率极高且功能简单，即使不进行注释也不会影响本领域人员对整体代码的理解。对于此类的基础代码，本公开提出利用稀有规则进行筛选，筛选后的代码为出现频率较低的代码。通过稀有规则对代码进行筛选，在一定程度上可以筛选出那些出现频率低、不常用的生僻代码。对这些生僻代码进行注释，可以有效帮助技术人员对代码进行理解及维护。响应于筛选后的代码中存在依赖包，在预设的文档库中查找该依赖包的注释，将依赖包的注释内容作为代码的注释。其中，依赖包的注释是由开发者编写的官方注释，具有较高的正确性和专业性。
77.在一些实施例中，操作s420中的获取依赖包注释，还包括：
78.统计依赖包注释的字数。
79.在字数超过阈值的情况下，执行注释缩写。
80.在一些实施例中，通常将字数的阈值定义为140词，即当依赖包注释的字数超过140词时，对依赖包注释执行注释缩写。通过执行注释缩写对第一注释内容的文本长度进行规范，避免因注释过长而导致阅读困难的情况出现。
81.其中，注释缩写任务依旧由上述算法模型执行。此时，该算法模型执行的下游任务为缩写任务，相应的，此时输入的任务描述和任务提示内容均为注释缩写相关内容。且由于上述算法模型为自回归模型，因此，通过该模型执行注释缩写任务，可以有效保证文本的连贯性和可读性，保证缩写后注释的质量。
82.响应于未获取到第一注释内容，执行基于待注释代码的函数名和变量类型的注释方式来获取第二注释内容。其中，基于待注释代码的函数名和变量类型获取注释内容，包括：基于编译器进行待注释代码中函数名和变量类型的识别，得到注释内容。
83.在一些实施例中，部分函数的函数名与该函数的功能一致，以python语言为例，函数sort的功能是对列表进行合理排序，与函数名sort的语义一致，函数split的功能是对语句进行分割处理，与函数名split的语义一致。因此，本公开提出对函数名进行语义分析，并将语义分析的结果作为该函数的注释。
84.变量用于存储在内存中的值，也就是说，在创建变量时会在内存中开辟一个空间。基于变量的数据类型分配指定内存，并决定什么数据可以被存储在内存中。因此，变量可以指定不同的数据类型，这些变量可以存储整数，小数或字符，例如变量类型包括整型、浮点型、字符型等。一个变量的类型决定了该变量可以包含什么样的值。通过编译器对待注释代码中的变量类型进行识别并注释，可以帮助技术人员快速判断该变量类型可以包含什么样的值，提高技术人员对代码理解的效率。
85.其中，基于编译器进行待注释代码识别还包括：确定待注释代码所使用的编程语言；基于所述编程语言将所述待注释代码输入至对应的编译器中；其中，每一编译器对应一种编程语言。在一些实施例中，根据编程语言选择相应的编译器，实现不同编程语言的有效识别，有效提高编译器的识别正确率，进而提高代码注释的准确率。
86.图5示意性示出了根据本公开实施例的基于待注释代码的依赖关系来获取第一注释内容的流程图。
87.如图5所示，该实施例的代码注释生成方法包括操作s510～操作s530。
88.在操作s510，基于待注释代码的类方法调用关系构建调用关系结构树。
89.在一些实施例中，通过递归遍历的方式对待注释代码中的类进行遍历，其中，未调用其他类的类即为调用关系结构树中的根节点，沿作为根节点的类继续遍历，得到根节点的子结点，子结点即为调用根节点类的子类；沿作为子结点的类继续遍历，得到子结点的叶子节点，叶子节点即为调用子结点类且没有被其他类调用的类。基于递归遍历可以有效梳理出待注释代码中类的调用关系，方便技术人员理解。基于类的调用关系构建调用关系结构树，可以实现待注释代码结构的直观解释，且在后续寻找同构关系结构树时，无需对待注释代码进行重复遍历，通过结构树的图形相似度比较即可实现同构关系结构树的查找，在节约设备资源的同时有效提高运行速度。
90.在操作s520，在预先构建的关系结构库中查找同构关系结构树。
91.在一些实施例中，预先构建的关系结构库中保存了多个开发模式代码对应的调用关系结构树，这些开发模式代码由业内权威人士发布，作为代码框架被技术人员广泛使用，即使在使用开发模式代码时，技术人员通常会根据自己的需求对开发模式代码进行精细化修改和填充，但是基础框架通常不会发生改变。
92.基于开发模式代码在实际应用中的这一特征，本公开提出通过将待注释代码的调用关系结构树与开发模式的调用关系结构树进行比较，以得到与待注释代码调用关系对应的开发模式代码。其中，可以通过比较待注释代码的调用关系结构树与开发模式的调用关系结构树的图形相似度实现同构关系结构树查找。
93.在操作s530，将同构关系结构树的代码注释作为第三注释内容。
94.在一些实施例中，若查找到待注释代码调用关系结构树的同构关系结构树，则将与该同构关系树对应的开发模式代码的注释作为第三注释内容。例如，基于同构关系结构树比较，发现待注释代码的调用关系树与开发模式中的装饰类的调用关系结构树一致，则将该装饰类的代码注释作为待注释代码的注释，即第三注释内容。
95.通过构建待注释代码的调用关系结构树，并基于图形相似度查找开发模式库中与待注释代码调用关系结构树相似的调用关系结构树，实现同构关系树的快速确定。且开发模式库中的调用关系结构树，仅需在开发模式代码入库时构建一次，后续可以直接通过已构建好的调用关系结构树进行相似度比较，有效节约比较结构树相似度的时间，提高代码注释生成的效率。
96.图6示意性示出了根据本公开实施例的基于待注释代码的语义内容获取第四注释内容的流程图。
97.如图6所示，该实施例的代码注释生成方法包括操作s610～操作s620。
98.在操作s610，在预先构建的算法注释库中查找符合条件的代码；其中，符合条件的代码为满足与待注释代码内容的相似值的代码。
99.在一些实施例中，通过算法模型进行待注释代码与算法注释库中的代码进行相似性比较，查找算法注释库中符合条件的代码。其中，符合条件的代码为与待注释代码内容相似值大于阈值的代码，通常将阈值设置为百分之九十。技术人员也可以根据实际情况对阈值进行修改，在此不作限定。操作s610中的算法模型与上述算法模型一致，在此不作赘述。
100.在操作s620，将所述符合条件的代码的注释作为第四注释内容。
101.在一些实施例中，在算法注释库中存在符合条件的代码的情况下，复用该代码的注释，将该代码的注释作为第四注释内容。
102.图7示意性示出了根据本公开实施例的预先构建的算法注释库的构建方法的流程图。
103.如图7所示，该实施例的代码注释生成方法包括操作s710～操作s730。
104.在操作s710，定期爬取网络中的开源代码及其注释。
105.在操作s720，统计开源代码的出现频率，基于出现频率确定常用代码。
106.在操作s730，响应于算法注释库中不包含该常用代码，将常用代码及其注释保存至算法注释库。
107.在一些实施例中，定期从网络中爬取开源代码及其注释，在爬取开源代码后，统计每一开源代码的出现频率，基于开源代码的出现频率确定常用代码。在将常用代码存储至算法注释库时，对算法注释库中已有代码进行查验，若该常用代码为算法注释库中已有代码，则无法保存至算法注释库，若该常用代码并未保存在算法注释库中，则执行保存操作，避免算法注释库中重复保存相同的常用代码。
108.可以理解的是，当开源代码的使用场景越广泛，该开源代码的出现频率越高，即该开源代码可以应用于不同场景、实现不同目的，若开源代码出现频率较低，例如，某一开源代码仅出现一次，说明该开源代码仅能应用于指定场景实现指定目的，局限性较高。因此，本公开提出，对爬取到的开源代码进行出现频率统计，并通过出现频率确定常用代码，将常用代码及其注释存储至算法注释库中，以节约算法注释库的存储空间，提高查找符合条件代码的速度，有效提高代码注释效率。
109.此外，在一些实施例中，还可以基于本公开提供的代码注释生成方法生成注释转译文档，对注释转译文档进行存储，方便存储和阅读。其中，注释转译文档包括生成注释的代码以及该代码的注释。
110.基于上述代码注释生成方法，本公开还提供了一种代码注释生成装置。以下将结合图8对该装置进行详细描述。
111.图8示意性示出了根据本公开实施例的代码注释生成装置的结构框图。
112.如图8所示，该实施例的代码注释生成装置800包括目标方式确定模块810、重复注释模块820、相似计算模块830、通用值计算模块840和注释终稿确定模块850。
113.目标方式确定模块810用于从多种注释方式确定目标注释方式。在一实施例中，目标方式确定模块810可以用于执行前文描述的操作s210，在此不再赘述。
114.重复注释模块820用于计算任意两份注释初稿之间的相似度，得到多个相似度值。在一实施例中，重复注释模块820可以用于执行前文描述的操作s220，在此不再赘述。
115.相似计算模块830用于计算任意两份注释初稿之间的相似度，得到多个相似度值。在一实施例中，相似计算模块830可以用于执行前文描述的操作s230，在此不再赘述。
116.通用值计算模块840用于根据所述多个相似度值确定每份注释初稿的通用值。在一实施例中，通用值计算模块840可以用于执行前文描述的操作s240，在此不再赘述。
117.注释终稿确定模块850用于比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。在一实施例中，注释终稿确定模块850可以用于执行前文描述的操作s250，在此不再赘述。
118.根据本公开的实施例，目标方式确定模块810、重复注释模块820、相似计算模块830、通用值计算模块840和注释终稿确定模块850中的任意多个模块可以合并在一个模块中实现，或者其中的任意一个模块可以被拆分成多个模块。或者，这些模块中的一个或多个模块的至少部分功能可以与其他模块的至少部分功能相结合，并在一个模块中实现。根据本公开的实施例，目标方式确定模块810、重复注释模块820、相似计算模块830、通用值计算模块840和注释终稿确定模块850中的至少一个可以至少被部分地实现为硬件电路，例如现场可编程门阵列(fpga)、可编程逻辑阵列(pla)、片上系统、基板上的系统、封装上的系统、专用集成电路(asic)，或可以通过对电路进行集成或封装的任何其他的合理方式等硬件或固件来实现，或以软件、硬件以及固件三种实现方式中任意一种或以其中任意几种的适当组合来实现。或者，目标方式确定模块810、重复注释模块820、相似计算模块830、通用值计算模块840和注释终稿确定模块850中的至少一个可以至少被部分地实现为计算机程序模块，当该计算机程序模块被运行时，可以执行相应的功能。
119.图9示意性示出了根据本公开实施例的适于实现代码注释生成方法的电子设备的方框图。
120.如图9所示，根据本公开实施例的电子设备900包括处理器901，其可以根据存储在只读存储器(rom)902中的程序或者从存储部分908加载到随机访问存储器(ram)903中的程序而执行各种适当的动作和处理。处理器901例如可以包括通用微处理器(例如cpu)、指令集处理器和/或相关芯片组和/或专用微处理器(例如，专用集成电路(asic))等等。处理器901还可以包括用于缓存用途的板载存储器。处理器901可以包括用于执行根据本公开实施例的方法流程的不同动作的单一处理单元或者是多个处理单元。
121.在ram 903中，存储有电子设备900操作所需的各种程序和数据。处理器901、rom 902以及ram 903通过总线904彼此相连。处理器901通过执行rom 902和/或ram 903中的程序来执行根据本公开实施例的方法流程的各种操作。需要注意，所述程序也可以存储在除rom 902和ram 903以外的一个或多个存储器中。处理器901也可以通过执行存储在所述一个或多个存储器中的程序来执行根据本公开实施例的方法流程的各种操作。
122.根据本公开的实施例，电子设备900还可以包括输入/输出(i/o)接口905，输入/输出(i/o)接口905也连接至总线904。电子设备900还可以包括连接至i/o接口905的以下部件中的一项或多项：包括键盘、鼠标等的输入部分906；包括诸如阴极射线管(crt)、液晶显示器(lcd)等以及扬声器等的输出部分907；包括硬盘等的存储部分908；以及包括诸如lan卡、调制解调器等的网络接口卡的通信部分909。通信部分909经由诸如因特网的网络执行通信处理。驱动器910也根据需要连接至i/o接口905。可拆卸介质911，诸如磁盘、光盘、磁光盘、半导体存储器等等，根据需要安装在驱动器910上，以便于从其上读出的计算机程序根据需要被安装入存储部分908。
123.本公开还提供了一种计算机可读存储介质，该计算机可读存储介质可以是上述实施例中描述的设备/装置/系统中所包含的；也可以是单独存在，而未装配入该设备/装置/系统中。上述计算机可读存储介质承载有一个或者多个程序，当上述一个或者多个程序被执行时，实现根据本公开实施例的方法。
124.根据本公开的实施例，计算机可读存储介质可以是非易失性的计算机可读存储介质，例如可以包括但不限于：便携式计算机磁盘、硬盘、随机访问存储器(ram)、只读存储器
(rom)、可擦式可编程只读存储器(eprom或闪存)、便携式紧凑磁盘只读存储器(cd-rom)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。例如，根据本公开的实施例，计算机可读存储介质可以包括上文描述的rom 902和/或ram 903和/或rom 902和ram 903以外的一个或多个存储器。
125.本公开的实施例还包括一种计算机程序产品，其包括计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。当计算机程序产品在计算机系统中运行时，该程序代码用于使计算机系统实现本公开实施例所提供的物品推荐方法。
126.在该计算机程序被处理器901执行时执行本公开实施例的系统/装置中限定的上述功能。根据本公开的实施例，上文描述的系统、装置、模块、单元等可以通过计算机程序模块来实现。
127.在一种实施例中，该计算机程序可以依托于光存储器件、磁存储器件等有形存储介质。在另一种实施例中，该计算机程序也可以在网络介质上以信号的形式进行传输、分发，并通过通信部分909被下载和安装，和/或从可拆卸介质911被安装。该计算机程序包含的程序代码可以用任何适当的网络介质传输，包括但不限于：无线、有线等等，或者上述的任意合适的组合。
128.在这样的实施例中，该计算机程序可以通过通信部分909从网络上被下载和安装，和/或从可拆卸介质911被安装。在该计算机程序被处理器901执行时，执行本公开实施例的系统中限定的上述功能。根据本公开的实施例，上文描述的系统、设备、装置、模块、单元等可以通过计算机程序模块来实现。
129.根据本公开的实施例，可以以一种或多种程序设计语言的任意组合来编写用于执行本公开实施例提供的计算机程序的程序代码，具体地，可以利用高级过程和/或面向对象的编程语言、和/或汇编/机器语言来实施这些计算程序。程序设计语言包括但不限于诸如java，c++，python，“c”语言或类似的程序设计语言。程序代码可以完全地在用户计算设备上执行、部分地在用户设备上执行、部分在远程计算设备上执行、或者完全在远程计算设备或服务器上执行。在涉及远程计算设备的情形中，远程计算设备可以通过任意种类的网络，包括局域网(lan)或广域网(wan)，连接到用户计算设备，或者，可以连接到外部计算设备(例如利用因特网服务提供商来通过因特网连接)。
130.附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，上述模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图或流程图中的每个方框、以及框图或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。
131.本领域技术人员可以理解，本公开的各个实施例和/或权利要求中记载的特征可以进行多种组合或/或结合，即使这样的组合或结合没有明确记载于本公开中。特别地，在
不脱离本公开精神和教导的情况下，本公开的各个实施例和/或权利要求中记载的特征可以进行多种组合和/或结合。所有这些组合和/或结合均落入本公开的范围。
132.以上对本公开的实施例进行了描述。但是，这些实施例仅仅是为了说明的目的，而并非为了限制本公开的范围。尽管在以上分别描述了各实施例，但是这并不意味着各个实施例中的措施不能有利地结合使用。本公开的范围由所附权利要求及其等同物限定。不脱离本公开的范围，本领域技术人员可以做出多种替代和修改，这些替代和修改都应落在本公开的范围之内。

技术特征：
1.一种代码注释生成方法，其特征在于，包括：从多种注释方式确定目标注释方式；基于所述目标注释方式重复对待注释代码进行注释，得到多份注释初稿；计算任意两份注释初稿之间的相似度，得到多个相似度值；根据所述多个相似度值确定每份注释初稿的通用值；比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。2.根据权利要求1所述的代码注释生成方法，其特征在于，所述从多种注释方式确定目标注释方式，包括：基于预设的优先级依次对所述待注释代码执行注释方式；将可以得到注释内容的注释方式确定为目标注释方式。3.根据权利要求2所述的代码注释生成方法，其特征在于，所述基于预设的优先级依次对所述待注释代码执行多种注释方式，包括：基于待注释代码的依赖关系来获取第一注释内容；响应于未获取到第一注释内容，执行基于待注释代码的函数名和变量类型的注释方式来获取第二注释内容；响应于未获取到第二注释内容，执行基于待注释代码的类方法调用关系的注释方式来获取第三注释内容；响应于未获取到第三注释内容，执行基于待注释代码的语义内容的注释方式来获取第四注释内容。4.根据权利要求2所述的代码注释生成方法，其特征在于，所述基于待注释代码的依赖关系来获取第一注释内容，包括：筛选待注释代码中符合稀有规则的代码；响应于筛选后的代码中存在依赖包，在预设的文档库中获取所述依赖包注释，得到所述第一注释内容；其中，所述筛选待注释代码中符合稀有规则的代码包括：统计每一代码的出现频次，将所述出现频次低于阈值的代码确定为符合稀有规则的代码；所述预设的文档库包含依赖包的官方注释。5.根据权利要求3所述的代码注释生成方法，其特征在于，在所述获取所述依赖包的注释，还包括：统计所述依赖包注释的字数；在所述字数超过阈值的情况下，执行注释缩写。6.根据权利要求2所述的代码注释生成方法，其特征在于，所述基于待注释代码的函数名和变量类型获取第二注释内容，包括：基于编译器进行待注释代码中函数名和变量类型的识别，得到第二注释内容；其中，基于编译器进行待注释代码识别还包括：确定待注释代码所使用的编程语言；基于所述编程语言将所述待注释代码输入至对应的编译器中；其中，每一编译器对应一种编程语言。7.根据权利要求2所述的代码注释生成方法，其特征在于，所述基于待注释代码的类方法调用关系获取第三注释内容，包括：
基于待注释代码的类方法调用关系构建调用关系结构树；在预先构建的关系结构库中查找同构关系结构树；将同构关系结构树的代码注释作为第三注释内容；其中，所述预先构建的关系结构库包含多个结构树以及与每一结构树对应的注释。8.根据权利要求2所述的代码注释生成方法，其特征在于，所述基于待注释代码的语义内容获取第四注释内容，包括：在预先构建的算法注释库中查找符合条件的代码；其中，所述符合条件的代码为满足与待注释代码内容的相似值的代码；将所述符合条件的代码注释作为第四注释内容。9.根据权利要求7所述的代码注释方法，其特征在于，所述预先构建的算法注释库的构建方法，包括：定期爬取网络中的开源代码及其注释；统计所述开源代码的出现频率，基于出现频率确定常用代码；响应于算法注释库中不包含该常用代码，将所述常用代码及其注释保存至算法注释库。10.根据权利要求1所述的代码注释方法，其特征在于，所述根据所述多个相似度值确定每个注释初稿的通用值，包括：计算该注释初稿与其余注释初稿之间相似度值的平均值，所述平均值即为该注释初稿的通用值。11.一种代码注释生成装置，包括：目标方式确定模块，用于从多种注释方式确定目标注释方式；重复注释模块，用于基于所述目标注释方式重复对待注释代码进行注释，得到多份注释初稿；相似计算模块，用于计算任意两份注释初稿之间的相似度，得到多个相似度值；通用值计算模块，用于根据所述多个相似度值确定每份注释初稿的通用值；以及注释终稿确定模块，用于比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。12.一种电子设备，包括：一个或多个处理器；存储装置，用于存储一个或多个程序，其中，当所述一个或多个程序被所述一个或多个处理器执行时，使得所述一个或多个处理器执行根据权利要求1～10中任一项所述的方法。13.一种计算机可读存储介质，其上存储有可执行指令，该指令被处理器执行时使处理器执行根据权利要求1～10中任一项所述的方法。14.一种计算机程序产品，包括计算机程序，所述计算机程序被处理器执行时实现根据权利要求1～10中任一项所述的方法。

技术总结
本公开提供了一种代码注释生成方法、装置、设备、存储介质和程序产品，可以应用于人工智能领域。该代码注释生成方法包括：从多种注释方式确定目标注释方式；基于目标注释方式重复对待注释代码进行注释，得到多份注释初稿；计算任意两份注释初稿之间的相似度，得到多个相似度值；根据多个相似度值确定每份注释初稿的通用值；比较每份注释初稿的通用值，将通用值最高的注释初稿确定为注释终稿。值最高的注释初稿确定为注释终稿。值最高的注释初稿确定为注释终稿。


技术研发人员：采安琪
受保护的技术使用者：中国工商银行股份有限公司
技术研发日：2023.05.17
技术公布日：2023/8/16