CN117539538B - 程序说明文档生成方法、装置、电子设备和可读介质 - Google Patents

Abstract

本公开的实施例公开了程序说明文档生成方法、装置、电子设备和可读介质。该方法的一具体实施方式包括：根据目标程序包对应的树状文件目录，获取目标程序包；根据程序文件对应的编程语言类型，对程序文件进行程序块提取，以生成程序块信息，得到程序块信息组；对于每个程序块信息，执行以下第一处理步骤：对程序块信息包括的程序块注释信息进行注释特征提取；对程序块信息包括的程序块代码信息进行代码特征提取；对程序块注释特征和程序块代码特征进行交叉特征融合；根据程序块融合特征，生成针对程序块信息的程序块说明信息；根据得到的程序块说明信息集合，生成针对目标程序包的程序说明文档。该实施方式提高了程序说明文档的编写效率。

Description

程序说明文档生成方法、装置、电子设备和可读介质

技术领域

本公开的实施例涉及计算机技术领域，具体涉及程序说明文档生成方法、装置、电子设备和可读介质。

背景技术

程序说明文档是用于对程序包含的各个API(Application ProgrammingInterface，应用程序接口)接口进行解释和说明的文档，其可以有效地辅助对程序包含的各个API接口的调用。目前，程序说明文档生成方式为：通过人工的方式，根据API接口对应的代码进行人工编写，以生成程序说明文档；

然而，发明人发现，当采用上述方式时，经常会存在如下技术问题：

针对大型程序开发项目，其对应的程序包内往往包含大量的API接口，通过人工编写程序说明文档的方式，程序说明文档的编写效率低下。

继续的，在自动生成程序说明文档的过程中，进一步存在如下技术问题：

常规的采用插件自动生成程序说明文档的方式，往往需要通过半侵入埋点和侵入埋点的方式对API接口对应的代码和注释进行采集，使得会增加代码的冗余度，同时随着API接口功能的变化，往往需要进行重新埋点，从而增加埋点工作量，以及降低程序说明文档的生成效率。

该背景技术部分中所公开的以上信息仅用于增强对本发明构思的背景的理解，并因此，其可包含并不形成本国的本领域普通技术人员已知的现有技术的信息。

发明内容

本公开的内容部分用于以简要的形式介绍构思，这些构思将在后面的具体实施方式部分被详细描述。本公开的内容部分并不旨在标识要求保护的技术方案的关键特征或必要特征，也不旨在用于限制所要求的保护的技术方案的范围。

本公开的一些实施例提出了程序说明文档生成方法、装置、电子设备和可读介质，来解决以上背景技术部分提到的技术问题中的一项或多项。

第一方面，本公开的一些实施例提供了一种程序说明文档生成方法，该方法包括：根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件；对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息；对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征；对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征；对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征；根据上述程序块融合特征，生成针对上述程序块信息的程序块说明信息；根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。

第二方面，本公开的一些实施例提供了一种程序说明文档生成装置，装置包括：获取单元，被配置成根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件；程序块提取单元，被配置成对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息；执行单元，被配置成对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征；对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征；对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征；根据上述程序块融合特征，生成单元，被配置成生成针对上述程序块信息的程序块说明信息；根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。

第三方面，本公开的一些实施例提供了一种电子设备，包括：一个或多个处理器；存储装置，其上存储有一个或多个程序，当一个或多个程序被一个或多个处理器执行，使得一个或多个处理器实现上述第一方面任一实现方式所描述的方法。

第四方面，本公开的一些实施例提供了一种计算机可读介质，其上存储有计算机程序，其中，程序被处理器执行时实现上述第一方面任一实现方式所描述的方法。

本公开的上述各个实施例具有如下有益效果：通过本公开的一些实施例的程序说明文档生成方法，提高了程序说明文档的编写效率。具体来说，造成程序说明文档的编写效率低下的原因在于：针对大型程序开发项目，其对应的程序包内往往包含大量的API接口，通过人工编写程序说明文档的方式，程序说明文档的编写效率低下。基于此，本公开的一些实施例的程序说明文档生成方法，首先，根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件。以此得到包含代码的至少一个程序文件。其次，对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息。实践中，不同的编程语言往往对应不同的语言特点，如Java编程语言包含有类等概念，C编程语言包含有结构体等概念，为了提高程序说明文档生成的鲁棒性，本申请以函数、类、结构体为分割单位，对程序文件进行程序块分割，以得到待进行程序说明的程序块信息。进一步，对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：第一步，对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。第二步，对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征。实践中，在代码撰写过程中，为了提高代码的可读性，往往配套有相应的解释性注释以辅助代码理解，即解释性注释与代码功能之间存在匹配关系。因此，本公开结合程序块注释信息和程序块代码信息，以辅助后续的程序说明文档生成。而由于程序块注释信息和程序块代码信息对应不同的信息表达方式，因此本申请通过特征提取的方式，以使得程序块注释信息和程序块代码信息映射至相同的特征空间，以及实现针对程序块注释信息和程序块代码信息的特征提取。第三步，对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征。实践中，由于程序块注释信息和程序块代码信息之间存在匹配关系，即特征之间存在一定冗余度，因此，本申请通过交叉特征融合的方式进行特征压缩，减少后续数据计算量。第四步，根据上述程序块融合特征，生成针对上述程序块信息的程序块说明信息。以此得到针对程序块(例如，API接口)的描述信息。最后，根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。通过此种方式可以自动化的生成程序说明文档，大大提高了程序说明文档的编写效率。

附图说明

结合附图并参考以下具体实施方式，本公开各实施例的上述和其他特征、优点及方面将变得更加明显。贯穿附图中，相同或相似的附图标记表示相同或相似的元素。应当理解附图是示意性的，元件和元素不一定按照比例绘制。

图1是根据本公开的程序说明文档生成方法的一些实施例的流程图；

图2是根据本公开的程序说明文档生成装置的一些实施例的结构示意图；

图3是适于用来实现本公开的一些实施例的电子设备的结构示意图。

具体实施方式

下面将参照附图更详细地描述本公开的实施例。虽然附图中显示了本公开的某些实施例，然而应当理解的是，本公开可以通过各种形式来实现，而且不应该被解释为限于这里阐述的实施例。相反，提供这些实施例是为了更加透彻和完整地理解本公开。应当理解的是，本公开的附图及实施例仅用于示例性作用，并非用于限制本公开的保护范围。

另外还需要说明的是，为了便于描述，附图中仅示出了与有关发明相关的部分。在不冲突的情况下，本公开中的实施例及实施例中的特征可以相互组合。

需要注意，本公开中提及的“第一”、“第二”等概念仅用于对不同的装置、模块或单元进行区分，并非用于限定这些装置、模块或单元所执行的功能的顺序或者相互依存关系。

需要注意，本公开中提及的“一个”、“多个”的修饰是示意性而非限制性的，本领域技术人员应当理解，除非在上下文另有明确指出，否则应该理解为“一个或多个”。

本公开实施方式中的多个装置之间所交互的消息或者信息的名称仅用于说明性的目的，而并不是用于对这些消息或信息的范围进行限制。

下面将参考附图并结合实施例来详细说明本公开。

参考图1，示出了根据本公开的程序说明文档生成方法的一些实施例的流程100。该程序说明文档生成方法，包括以下步骤：

步骤101，根据目标程序包对应的树状文件目录，获取目标程序包。

在一些实施例中，程序说明文档生成方法的执行主体(例如，计算设备)可以根据目标程序包对应的树状文件目录，获取上述目标程序包。其中，上述目标程序包是待生成对应程序说明文档的软件程序包。实践中，上述目标程序包可以是程序项目开发文件对应的程序包。目标程序包可以包括：至少一个程序文件。其中，程序文件可以是包含有程序代码的文件。树状文件目录可以是表征目标程序包内文件结构的目录。实践中，上述执行主体可以通过Tree命令，得到目标程序包对应的树状文件目录。具体的，上述执行主体可以读取树状文件目录中的每个目录文件内的程序文件，得到上述目标程序包。

需要说明的是，上述计算设备可以是硬件，也可以是软件。当计算设备为硬件时，可以实现成多个服务器或终端设备组成的分布式集群，也可以实现成单个服务器或单个终端设备。当计算设备体现为软件时，可以安装在上述所列举的硬件设备中。其可以实现成例如用来提供分布式服务的多个软件或软件模块，也可以实现成单个软件或软件模块。在此不做具体限定。应该理解，计算设备的数目根据实现需要可以具有任意数目。

在一些实施例的一些可选的实现方式中，上述执行主体根据目标程序包对应的树状文件目录，获取上述目标程序包，可以包括以下步骤：

第一步，深度遍历上述树状文件目录，以确定上述树状文件目录包括的文件名对应的文件，作为候选文件，得到候选文件集合。

作为示例，树状文件目录可以包括：A节点、B节点和C节点。A节点是B节点和C节点的父节点。其中，A节点对应文件夹A。B节点对应文件夹B。C节点对应文件夹C。文件夹B中存储有文件B1和文件B2。文件夹C存储有文件C1、文件C2、文件C3和文件C4。其中，文件B1的文件后缀为“.PNG”。文件B2的文件后缀为“.JPG”。文件C1的文件后缀为“.CPP”。文件C2的文件后缀为“.Java”。文件C3的文件后缀为“.PY”。C4的文件后缀为“.C”。具体的，上述执行主体可以深度遍历A节点和B节点，并读取B节点对应的文件夹A内的文件，得到候选文件，即文件B1和文件B2。以及深度遍历A节点和C节点，并读取C节点对应的文件夹C内的文件，得到候选文件，即文件C1、文件C2、文件C3和文件C4。即候选文件集合为[文件B1，文件B2，文件C1，文件C2，文件C3，文件C4]。

第二步，根据预设文件类型列表，对上述候选文件集合进行文件过滤，得到上述目标程序包。

其中，预设文件类型列表包含了各编程语言对应的源文件的文件后缀。例如，预设文件类型列表可以是[“.CPP”，“.C”，“.PY”，“.Java”]。

作为示例，候选文件集合为[文件B1，文件B2，文件C1，文件C2，文件C3，文件C4]。由于文件B1的文件后缀为“.PNG”。文件B2的文件后缀为“.JPG”，即未包含于预设文件类型列表内，因此，过滤得到的目标程序包可以是[文件C1，文件C2，文件C3，文件C4]。

步骤102，对于至少一个程序文件中的每个程序文件，根据程序文件对应的编程语言类型，对程序文件进行程序块提取，以生成程序块信息，得到程序块信息组。

在一些实施例中，对于至少一个程序文件中的每个程序文件，上述执行主体可以根据程序文件对应的编程语言类型，对程序文件进行程序块提取，以生成程序块信息，得到程序块信息组。其中，程序块信息表征以下之一：函数块，结构体块和类块。其中，函数块是指程序函数对应的函数体区域。结构体块是指结构体对应的结构体对应的结构体区域。类块是指类对应的类区域。实践中，不同的编程语言具有不同的语言特点。例如，Java语言、Python语言和C++语言因为面向对象编程语言，因此除函数外，还包括类。而C语言为过程式编程语言，因此除函数外，还包括结构体。程序块信息包括：程序块注释信息和程序块代码信息。程序块注释信息表征程序块内的代码注释。程序块代码信息表征程序块内的代码。

作为示例，程序块信息对应的程序块可以是：

def Function(parameter):

Operation//annotation

return ReturnValue

其中，“Function”表示函数名称。“parameter”表示形式参数，“Operation”表示函数内容。“ReturnValue”表示函数返回值。“annotation”表征注释，即本示例对应的程序块注释信息。上述程序块信息对应的程序块内除注释以外的内容为程序块代码信息。

作为又一示例，程序块信息对应的程序块可以是：

其中，“ClassName”表示类名。“ClassFunction”表征类包含的函数名。“annotation”表征注释，即本示例对应的程序块注释信息。上述程序块信息对应的程序块内除注释以外的内容为程序块代码信息。

在一些实施例的一些可选的实现方式中，上述执行主体根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，可以包括以下步骤：

第一步，响应于确定上述程序文件对应的编程语言类型为第一编程语言类型，通过与上述第一编程语言类型对应的第一正则表达式列表，对上述程序文件进行遍历。

其中，第一编程语言类型可以是表征面向对象编程语言类型。例如，Java语言类型，C++语言类型，Python语言类型。第一正则表达式列表中的第一正则表达式用于提取程序文件中的函数对应的函数区域和类区域。

第二步，响应于遍历到第一行位置，执行以下第一提取步骤：

第一子步骤，提取第一作用域内的程序代码，作为第一候选程序代码。

第二步，对上述第一候选程序代码进行注释和代码分离，以得到程序块信息包括的程序块注释信息和程序块代码信息。

其中，第一行位置是与上述第一正则表达式列表中的第一正则表达式匹配的位置。实践中，第一行位置可以是函数名所在行位置，或类名所在行位置。以上述第一行位置为起始位置的、由上述第一行位置对应的起止符框定的区域为上述第一作用域的子区域。其中，起止符可以是花括号。

作为示例，如下代码所示：

其中，第一行位置可以是“def FindMaxValue(ListK):”所在行位置。第一作用域可以是由“#This Function aim to find the biggest value in the list”所在行位置至“return t”所在行位置。实践中，除包含在函数区域内的、对函数操作进行注释的函数注释外，还可能包含对函数整体的函数注释，例如“#This Function aim to find thebiggest value in the list”。因此，程序块注释信息可以[“This Function aim to findthe biggest value in the list”，“Initialize maximum value”，“Update maximumvalue”]，程序块代码信息可以是第一作用域内除程序块注释信息以外的代码。

第三步，响应于确定响应于确定上述程序文件对应的编程语言类型为第二编程语言类型，通过与上述第二编程语言类型对应的第二正则表达式列表，对上述程序文件进行遍历。

其中，第二编程语言类型可以是过程式编程语言类型。例如，C语言类型。第二正则表达式列表中的第二正则表达式用于提取程序文件中的函数对应的函数区域和结构体区域。

第四步，响应于遍历到第二行位置，执行以下第二提取步骤：

第一子步骤，提取第二作用域内的程序代码，作为第二候选程序代码。

第二子步骤，对上述第二候选程序代码进行注释和代码分离，以得到程序块信息包括的程序块注释信息和程序块代码信息。

其中，上述第二行位置是与上述第二正则表达式列表中的第二正则表达式匹配的位置。实践中，第二行位置可以是函数名所在行位置，或结构体名所在行位置。以上述第二行位置为起始位置的、满足字符缩进条件的区域为上述第二作用域的子区域。缩进条件可以是4字符缩进。

作为示例，如下代码所示：

其中，第一行位置可以是“int FindMaxValue(int ListK[10])”所在行位置。第二作用域可以是由“#This Function aim to find the biggest value in the list”所在行位置至“return t”所在行位置。实践中，除包含在函数区域内的、对函数操作进行注释的函数注释外，还可能包含对函数整体的函数注释，例如“#This Function aim to find thebiggest value in the list”。因此，程序块注释信息可以[“This Function aim to findthe biggest value in the list”，“Initialize maximum value”，“Update maximumvalue”]，程序块代码信息可以是第一作用域内除程序块注释信息以外的代码。

步骤103，对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：

步骤1031，对程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。

在一些实施例中，上述执行主体可以对程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。其中，上述执行主体可以通过BERT模型，对程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。

在一些实施例的一些可选的实现方式中，上述执行主体对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征，可以包括以下步骤：

第一步，对上述程序块注释信息进行拆分，以生成全局程序块注释信息和局部程序块注释信息。

其中，全局程序块注释信息可以是针对程序块整体的注释。局部程序块注释信息可以是程序块内包含的注释。

作为示例，如下代码所示：

其中，上述代码对应的程序块注释信息可以[“This Function aim to find thebiggest value in the list”，“Initialize maximum value”，“Update maximumvalue”]。其中，“This Function aim to find the biggest value in the list”可以是全局程序块注释信息。[“Initialize maximum value”，“Update maximum value”]可以是局部程序块注释信息。具体的，程序块注释信息是以列表的形式，按序存储注释，因此在具体实践中，上述执行主体可以将程序块注释信息中的第一个注释，作为全局程序块注释信息，将除全局程序块注释信息以外的注释，作为局部程序块注释信息。

可选地，程序块注释信息包括：程序块注释对集合，上述程序块注释对集合中的程序块注释对包括：程序块注释和注释位置。其中，注释位置表征程序块注释在程序文件中的行位置。

可选地，上述执行主体对上述程序块注释信息进行拆分，以生成全局程序块注释信息和局部程序块注释信息，可以包括以下步骤：

步骤1：将对应的注释位置小于上述第一行位置，或对应的注释位置小于第二行位置的程序块注释对包括的程序块注释，确定为上述全局程序块注释信息。

步骤2：将对应的注释位置大于等于上述第一行位置，或对应的注释位置大于等于第二行位置的至少一个程序块注释对包括的程序块注释，确定为上述局部程序块注释信息。

第二步，对上述全局程序块注释信息进行段落特征提取，以生成全局程序块注释。

实践中，上述执行主体可以通过BERT模型，对上述全局程序块注释信息进行段落特征提取，以生成全局程序块注释。

第三步，对上述局部程序块注释信息进行分割，得到分割后局部程序块注释信息集合。

实践中，上述执行主体可以以单个注释为分割粒度，对上述局部程序块注释信息进行分割，得到分割后局部程序块注释信息集合。

作为示例，局部程序块注释信息可以是[“Initialize maximum value”，“Updatemaximum value”]。分割后局部程序块注释信息集合可以是[[“Initialize maximumvalue”]，[“Update maximum value”]]。

第四步，对上述分割后局部程序块注释信息集合中的每个分割后局部程序块注释信息进行段落特征提取，以生成局部程序块注释子特征，得到局部程序块注释子特征集合。

实践中，上述执行主体可以通过BERT模型，对分割后局部程序块注释信息进行段落特征提取，以生成局部程序块注释子特征。

第五步，将上述全局程序块注释和上述局部程序块注释子特征集合进行拼接，以生成上述程序块信息包括的程序块注释信息对应的程序块注释特征。

实践中，上述执行主体可以采用前后拼接的方式，将上述全局程序块注释和上述局部程序块注释子特征集合进行拼接，以生成上述程序块信息包括的程序块注释信息对应的程序块注释特征。

步骤1032，对程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征。

在一些实施例中，上述执行主体可以通过双模编码解码模型，对程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征。

其中，双模编码解码模型包括：2个编码器和1个解码器，2个编码器并行设置，与解码器串行连接。2个编码器包括：编码器A和编码器B。编码器A和编码器B的网络结构一致，编码器A用于对程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。编码器B用于对程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征。编码器A和编码器B采用Transformer结构作为骨架结构。

步骤1033，对程序块注释特征和程序块代码特征进行交叉特征融合，以生成程序块融合特征。

在一些实施例中，上述执行主体可以对程序块注释特征和程序块代码特征进行交叉特征融合，以生成程序块融合特征。

作为示例，程序块注释特征可以是[“特征A1”，“特征A2”，“特征A3”]。程序块代码特征可以是[“特征B1”，“特征B2”，“特征B3”]。以“特征A1”为例，步骤1：上述执行主体可以通过[MASK]遮掩符遮掩程序块注释特征中的“特征A1”，即遮掩后的程序块注释特征可以是[“[MASK]”，“特征A2”，“特征A3”]。步骤2：上述执行主体可以根据[“特征B1”，“特征B2”，“特征B3”]来预测[MASK]遮掩符位置处的特征，若预测结果与“特征A1”一致，表征[“特征B1”，“特征B2”，“特征B3”]中存在与“特征A1”近似的特征，则上述执行主体可以将“特征A1”确定为待剔除特征。若预测结果与“特征A1”不一致，表征[“特征B1”，“特征B2”，“特征B3”]中不存在与“特征A1”近似的特征，则上述执行主体可以保留“特征A1”。步骤3：上述执行主体可以对程序块注释特征中的“特征A1”、“特征A2”、“特征A3”均执行步骤1至步骤2。最后，上述执行主体可以将剔除待剔除特征的程序块注释特征和程序块代码特征拼接，得到上述程序块融合特征。

步骤1034，根据程序块融合特征，生成针对程序块信息的程序块说明信息。

在一些实施例中，上述执行主体可以将程序块融合特征输入解码器，以生成针对程序块信息的程序块说明信息。

上述步骤1031至步骤1032中的内容，作为本公开的一个发明点，解决了背景技术提及的技术问题，即“常规的采用插件自动生成程序说明文档的方式，往往需要通过半侵入埋点和侵入埋点的方式对API接口对应的代码和注释进行采集，使得会增加代码的冗余度，同时随着API接口功能的变化，往往需要进行重新埋点，从而增加埋点工作量，以及降低程序说明文档的生成效率”。基于此，本公开从程序块注释特征和程序块代码特征角度出发，以此预测对应的程序块功能，得到相应的成块说明信息。在预测过程中，考虑到程序块对应的代码中并非所有代码对应有注释，换言之，程序块对应的代码中仅部分代码对应有注释，在特征处理过程中，此部分代码与对应的注释存在特征重复的情况，直接输入解码器，存在特征重复处理的情况，造成了计算资源的浪费。而直接剔除程序块注释特征，则有忽略了注释对于代码的约束限定作用，由此，在特征输入解码器之间，本申请通过交叉特征融合的方式，即以程序块代码特征为基准，预测程序块注释特征中被遮掩符遮掩的特征对应的预测结果，并根据预测结果进行相似特征去重，以此降低特征维度和特征冗余度。从而保证了后续生成的程序块说明信息的准确性。同时，此种方式也不会对代码产生侵入，避免了因埋点所产生的埋点工作量，提高了程序说明文档的生成效率。

步骤104，根据得到的程序块说明信息集合，生成针对目标程序包的程序说明文档。

在一些实施例中，上述执行主体可以根据得到的程序块说明信息集合，生成针对目标程序包的程序说明文档。其中，程序说明文档是指对目标程序包内的、程序块对应的内容进行解释说明的文档。具体的，上述执行主体可以对程序块说明信息集合中的程序块说明信息进行组合，以生成程序说明文档。

可选的，上述方法还包括：

第一步，对于上述程序块说明信息集合中的每个程序块说明信息，执行以下第二步骤：

第一子步骤，对上述程序块说明信息进行关键词提取，以生成关键词集合。

实践中，首先，上述执行主体可以对程序块说明信息进行分词处理。然后，上述执行主体可以通过TF-IDF算法对上述程序块说明信息进行关键词提取，以生成关键词集合。

第二子步骤，生成上述关键词集合中的每个关键词对应的关键词向量，得到关键词向量集合。

实践中，上述执行主体可以通过Word2Vec模型，生成关键词对应的关键词向量。

第三子步骤，确定上述关键词向量集合中的每个关键词向量和上述程序块说明信息对应的程序块融合特征的特征相似度。

实践中，上述执行主体可以通过计算余弦相似度的方式，关键词向量和上述程序块说明信息对应的程序块融合特征的特征相似度。具体的，由于关键词向量和程序块融合特征的向量长度不同，因此，可以对关键词向量进行补0，以达到向量对齐的目的。

第四子步骤，根据关键词向量对应的特征相似度，对上述关键词集合中的关键词进行排序，以生成关键词序列。

实践中，上述执行主体可以根据关键词向量对应的特征相似度，对上述关键词集合中的关键词进行递增排序，以生成关键词序列。

第二步，根据得到的关键词序列组中的关键词对应的关键词词频，对上述关键词序列组中的关键词进行词排序，以生成关键词数组。

其中，关键词词频表征关键词在关键词序列组的出现频率。

第三步，对于上述关键词序列组中的每组关键词序列，将目标程序块说明信息对应的程序块融合特征与上述关键词序列在上述关键词数组中对应的关键词进行关联。

其中，目标程序块说明信息是上述关键词序列对应的程序块说明信息。

作为示例，关键词序列可以是[关键词K1，关键词K2，关键词K3，关键词K4，关键词K5]。程序块说明信息A可以与关键词K1、关键词K2和关键词K3关联。程序块说明信息B可以与关键词K2、关键词K3和关键词K4关联。程序块说明信息C可以与关键词K4和关键词K5关联。

第四步，响应于接收到待实现功能描述信息，对上述待实现功能描述信息进行词粒度分割，以生成候选词集合。

实践中，待实现功能描述信息可以是待实现的、函数功能描述信息。具体的，上述执行主体可以通过Jieba分词，对待实现功能描述信息进行词粒度分割，以生成候选词集合。

第五步，从上述候选词集合中筛选出满足第一筛选条件的候选词，作为功能描述词，得到功能描述词集合。

其中，第一筛选条件可以是：候选词的词性可以是功能描述词。

第六步，将上述功能描述词集合与上述关键词数组进行词匹配，以激活与上述关键词数组关联的、程序块说明信息对应的激活向量中的向量值。

其中，激活向量中的向量值的数量与程序块说明信息在上述关键词数组中对应的关键词的数量相同。激活向量中的向量值在词匹配成功时处于激活状态。激活向量中的向量值在词匹配失败时处于非激活状态。实践中，向量值为“1”时表征处于激活状态。向量值为“0”时表征处于非激活状态。

作为示例，关键词序列可以是[关键词K1，关键词K2，关键词K3，关键词K4，关键词K5]。程序块说明信息A可以与关键词K1、关键词K2和关键词K3关联。程序块说明信息A对应的激活向量的长度为3，具体的，程序块说明信息A对应的激活向量在非激活状态下为[0，0，0]。当程序块说明信息A对应的激活向量为[1，0，0]时，表征，功能描述词集合中存在与关键词K1相似的功能描述词。

第七步，将对应的激活向量满足第二筛选条件的至少一个程序块说明信息返回至目标终端。

其中，目标终端是发送上述待实现功能描述信息的终端。第二筛选条件可以是处于激活状态的向量值占激活向量中的向量值的比重大于50％。

本公开的上述各个实施例具有如下有益效果：通过本公开的一些实施例的程序说明文档生成方法，提高了程序说明文档的编写效率。具体来说，造成程序说明文档的编写效率低下的原因在于：针对大型程序开发项目，其对应的程序包内往往包含大量的API接口，通过人工编写程序说明文档的方式，程序说明文档的编写效率低下。基于此，本公开的一些实施例的程序说明文档生成方法，首先，根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件。以此得到包含代码的至少一个程序文件。其次，对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息。实践中，不同的编程语言往往对应不同的语言特点，如Java编程语言包含有类等概念，C编程语言包含有结构体等概念，为了提高程序说明文档生成的鲁棒性，本申请以函数、类、结构体为分割单位，对程序文件进行程序块分割，以得到待进行程序说明的程序块信息。进一步，对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：第一步，对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征。第二步，对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征。实践中，在代码撰写过程中，为了提高代码的可读性，往往配套有相应的解释性注释以辅助代码理解，即解释性注释与代码功能之间存在匹配关系。因此，本公开结合程序块注释信息和程序块代码信息，以辅助后续的程序说明文档生成。而由于程序块注释信息和程序块代码信息对应不同的信息表达方式，因此本申请通过特征提取的方式，以使得程序块注释信息和程序块代码信息映射至相同的特征空间，以及实现针对程序块注释信息和程序块代码信息的特征提取。第三步，对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征。实践中，由于程序块注释信息和程序块代码信息之间存在匹配关系，即特征之间存在一定冗余度，因此，本申请通过交叉特征融合的方式进行特征压缩，减少后续数据计算量。第四步，根据上述程序块融合特征，生成针对上述程序块信息的程序块说明信息。以此得到针对程序块(例如，API接口)的描述信息。最后，根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。通过此种方式可以自动化的生成程序说明文档，大大提高了程序说明文档的编写效率。

进一步参考图2，作为对上述各图所示方法的实现，本公开提供了一种程序说明文档生成装置的一些实施例，这些装置实施例与图1所示的那些方法实施例相对应，该程序说明文档生成装置具体可以应用于各种电子设备中。

如图2所示，一些实施例的程序说明文档生成装置200包括：获取单元201、程序块提取单元202、执行单元203和生成单元204。获取单元201，被配置成根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件；程序块提取单元202，被配置成对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息；执行单元203，被配置成对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征；对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征；对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征；根据上述程序块融合特征，生成针对上述程序块信息的程序块说明信息；生成单元204，被配置成根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。

可以理解的是，该程序说明文档生成装置200中记载的诸单元与参考图1描述的方法中的各个步骤相对应。由此，上文针对方法描述的操作、特征以及产生的有益效果同样适用于程序说明文档生成装置200及其中包含的单元，在此不再赘述。

下面参考图3，其示出了适于用来实现本公开的一些实施例的电子设备(例如，计算设备)300的结构示意图。图3示出的电子设备仅仅是一个示例，不应对本公开的实施例的功能和使用范围带来任何限制。

如图3所示，电子设备300可以包括处理装置(例如中央处理器、图形处理器等)301，其可以根据存储在只读存储器302中的程序或者从存储装置308加载到随机访问存储器303中的程序而执行各种适当的动作和处理。在随机访问存储器303中，还存储有电子设备300操作所需的各种程序和数据。处理装置301、只读存储器302以及随机访问存储器303通过总线304彼此相连。输入/输出接口305也连接至总线304。

通常，以下装置可以连接至I/O接口305：包括例如触摸屏、触摸板、键盘、鼠标、摄像头、麦克风、加速度计、陀螺仪等的输入装置306；包括例如液晶显示器(LCD)、扬声器、振动器等的输出装置307；包括例如磁带、硬盘等的存储装置308；以及通信装置309。通信装置309可以允许电子设备300与其他设备进行无线或有线通信以交换数据。虽然图3示出了具有各种装置的电子设备300，但是应理解的是，并不要求实施或具备所有示出的装置。可以替代地实施或具备更多或更少的装置。图3中示出的每个方框可以代表一个装置，也可以根据需要代表多个装置。

特别地，根据本公开的一些实施例，上文参考流程图描述的过程可以被实现为计算机软件程序。例如，本公开的一些实施例包括一种计算机程序产品，其包括承载在计算机可读介质上的计算机程序，该计算机程序包含用于执行流程图所示的方法的程序代码。在这样的一些实施例中，该计算机程序可以通过通信装置309从网络上被下载和安装，或者从存储装置308被安装，或者从只读存储器302被安装。在该计算机程序被处理装置301执行时，执行本公开的一些实施例的方法中限定的上述功能。

需要说明的是，本公开的一些实施例中记载的计算机可读介质可以是计算机可读信号介质或者计算机可读存储介质或者是上述两者的任意组合。计算机可读存储介质例如可以是——但不限于——电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。计算机可读存储介质的更具体的例子可以包括但不限于：具有一个或多个导线的电连接、便携式计算机磁盘、硬盘、随机访问存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑磁盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。在本公开的一些实施例中，计算机可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。而在本公开的一些实施例中，计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了计算机可读的程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。计算机可读信号介质还可以是计算机可读存储介质以外的任何计算机可读介质，该计算机可读信号介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。计算机可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于：电线、光缆、RF(射频)等等，或者上述的任意合适的组合。

在一些实施方式中，客户端、服务器可以利用诸如HTTP(Hyper Text TransferProtocol，超文本传输协议)之类的任何当前已知或未来研发的网络协议进行通信，并且可以与任意形式或介质的数字数据通信(例如，通信网络)互连。通信网络的示例包括局域网(“LAN”)，广域网(“WAN”)，网际网(例如，互联网)以及端对端网络(例如，ad hoc端对端网络)，以及任何当前已知或未来研发的网络。

上述计算机可读介质可以是上述电子设备中所包含的；也可以是单独存在，而未装配入该电子设备中。上述计算机可读介质承载有一个或者多个程序，当上述一个或者多个程序被该电子设备执行时，使得该电子设备：根据目标程序包对应的树状文件目录，获取上述目标程序包，其中，上述目标程序包是待生成对应程序说明文档的软件程序包，上述目标程序包包括：至少一个程序文件；对于上述至少一个程序文件中的每个程序文件，根据上述程序文件对应的编程语言类型，对上述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息；对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：对上述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征；对上述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征；对上述程序块注释特征和上述程序块代码特征进行交叉特征融合，以生成程序块融合特征；根据上述程序块融合特征，生成针对上述程序块信息的程序块说明信息；根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档。

可以以一种或多种程序设计语言或其组合来编写用于执行本公开的一些实施例的操作的计算机程序代码，上述程序设计语言包括面向对象的程序设计语言—诸如Java、Smalltalk、C++，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算机上执行、部分地在用户计算机上执行、作为一个独立的软件包执行、部分在用户计算机上部分在远程计算机上执行、或者完全在远程计算机或服务器上执行。在涉及远程计算机的情形中，远程计算机可以通过任意种类的网络——包括局域网(LAN)或广域网(WAN)——连接到用户计算机，或者，可以连接到外部计算机(例如利用因特网服务提供商来通过因特网连接)。

附图中的流程图和框图，图示了按照本公开各种实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段、或代码的一部分，该模块、程序段、或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个接连地表示的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或操作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

描述于本公开的一些实施例中的单元可以通过软件的方式实现，也可以通过硬件的方式来实现。所描述的单元也可以设置在处理器中，例如，可以描述为：一种处理器包括获取单元、程序块提取单元、执行单元和生成单元。其中，这些单元的名称在某种情况下并不构成对该单元本身的限定，例如，生成单元还可以被描述为“根据得到的程序块说明信息集合，生成针对上述目标程序包的程序说明文档的单元”。

本文中以上描述的功能可以至少部分地由一个或多个硬件逻辑部件来执行。例如，非限制性地，可以使用的示范类型的硬件逻辑部件包括：现场可编程门阵列(FPGA)、专用集成电路(ASIC)、专用标准产品(ASSP)、片上系统(SOC)、复杂可编程逻辑设备(CPLD)等等。

以上描述仅为本公开的一些较佳实施例以及对所运用技术原理的说明。本领域技术人员应当理解，本公开的实施例中所涉及的发明范围，并不限于上述技术特征的特定组合而成的技术方案，同时也应涵盖在不脱离上述发明构思的情况下，由上述技术特征或其等同特征进行任意组合而形成的其它技术方案。例如上述特征与本公开的实施例中公开的(但不限于)具有类似功能的技术特征进行互相替换而形成的技术方案。

Claims (5)

1.一种程序说明文档生成方法，包括：

根据目标程序包对应的树状文件目录，获取所述目标程序包，其中，所述目标程序包是待生成对应程序说明文档的软件程序包，所述目标程序包包括：至少一个程序文件；

对于所述至少一个程序文件中的每个程序文件，根据所述程序文件对应的编程语言类型，对所述程序文件进行程序块提取，以生成程序块信息，得到程序块信息组，其中，程序块信息对应的程序块表征以下之一：函数块，结构体块和类块，程序块信息包括：程序块注释信息和程序块代码信息；

对于得到的程序块信息组集合中的每个程序块信息，执行以下第一处理步骤：

对所述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征；

对所述程序块信息包括的程序块代码信息进行代码特征提取，以生成程序块代码特征；

对所述程序块注释特征和所述程序块代码特征进行交叉特征融合，以生成程序块融合特征；

根据所述程序块融合特征，生成针对所述程序块信息的程序块说明信息；

根据得到的程序块说明信息集合，生成针对所述目标程序包的程序说明文档；

对于所述程序块说明信息集合中的每个程序块说明信息，执行以下第二步骤：

对所述程序块说明信息进行关键词提取，以生成关键词集合；

生成所述关键词集合中的每个关键词对应的关键词向量，得到关键词向量集合；

确定所述关键词向量集合中的每个关键词向量和所述程序块说明信息对应的程序块融合特征的特征相似度；

根据关键词向量对应的特征相似度，对所述关键词集合中的关键词进行排序，以生成关键词序列；

根据得到的关键词序列组中的关键词对应的关键词词频，对所述关键词序列组中的关键词进行词排序，以生成关键词数组，其中，关键词词频表征关键词在关键词序列组的出现频率；

对于所述关键词序列组中的每组关键词序列，将目标程序块说明信息对应的程序块融合特征与所述关键词序列在所述关键词数组中对应的关键词进行关联，其中，所述目标程序块说明信息是所述关键词序列对应的程序块说明信息；

响应于接收到待实现功能描述信息，对所述待实现功能描述信息进行词粒度分割，以生成候选词集合；

从所述候选词集合中筛选出满足第一筛选条件的候选词，作为功能描述词，得到功能描述词集合；

将所述功能描述词集合与所述关键词数组进行词匹配，以激活与所述关键词数组关联的、程序块说明信息对应的激活向量中的向量值，其中，激活向量中的向量值的数量与程序块说明信息在所述关键词数组中对应的关键词的数量相同，激活向量中的向量值在词匹配成功时处于激活状态，激活向量中的向量值在词匹配失败时处于非激活状态；

将对应的激活向量满足第二筛选条件的至少一个程序块说明信息返回至目标终端，其中，所述目标终端是发送所述待实现功能描述信息的终端，其中，

所述根据目标程序包对应的树状文件目录，获取所述目标程序包，包括：

深度遍历所述树状文件目录，以确定所述树状文件目录包括的文件名对应的文件，作为候选文件，得到候选文件集合；

根据预设文件类型列表，对所述候选文件集合进行文件过滤，得到所述目标程序包，其中，

所述根据所述程序文件对应的编程语言类型，对所述程序文件进行程序块提取，以生成程序块信息，包括：

响应于确定所述程序文件对应的编程语言类型为第一编程语言类型，通过与所述第一编程语言类型对应的第一正则表达式列表，对所述程序文件进行遍历；

响应于遍历到第一行位置，执行以下第一提取步骤：

提取第一作用域内的程序代码，作为第一候选程序代码；

对所述第一候选程序代码进行注释和代码分离，以得到程序块信息包括的程序块注释信息和程序块代码信息，其中，所述第一行位置是与所述第一正则表达式列表中的第一正则表达式匹配的位置，以所述第一行位置为起始位置的、由所述第一行位置对应的起止符框定的区域为所述第一作用域的子区域；

响应于确定所述程序文件对应的编程语言类型为第二编程语言类型，通过与所述第二编程语言类型对应的第二正则表达式列表，对所述程序文件进行遍历；

响应于遍历到第二行位置，执行以下第二提取步骤：

提取第二作用域内的程序代码，作为第二候选程序代码；

对所述第二候选程序代码进行注释和代码分离，以得到程序块信息包括的程序块注释信息和程序块代码信息，其中，所述第二行位置是与所述第二正则表达式列表中的第二正则表达式匹配的位置，以所述第二行位置为起始位置的、满足字符缩进条件的区域为所述第二作用域的子区域。

2.根据权利要求1所述的方法，其中，所述对所述程序块信息包括的程序块注释信息进行注释特征提取，以生成程序块注释特征，包括：

对所述程序块注释信息进行拆分，以生成全局程序块注释信息和局部程序块注释信息；

对所述全局程序块注释信息进行段落特征提取，以生成全局程序块注释；

对所述局部程序块注释信息进行分割，得到分割后局部程序块注释信息集合；

对所述分割后局部程序块注释信息集合中的每个分割后局部程序块注释信息进行段落特征提取，以生成局部程序块注释子特征，得到局部程序块注释子特征集合；

将所述全局程序块注释和所述局部程序块注释子特征集合进行拼接，以生成所述程序块信息包括的程序块注释信息对应的程序块注释特征。

3.根据权利要求2所述的方法，其中，程序块注释信息包括：程序块注释对集合，所述程序块注释对集合中的程序块注释对包括：程序块注释和注释位置；以及

所述对所述程序块注释信息进行拆分，以生成全局程序块注释信息和局部程序块注释信息，包括：

将对应的注释位置小于所述第一行位置，或对应的注释位置小于第二行位置的程序块注释对包括的程序块注释，确定为所述全局程序块注释信息；

将对应的注释位置大于等于所述第一行位置，或对应的注释位置大于等于第二行位置的至少一个程序块注释对包括的程序块注释，确定为所述局部程序块注释信息。

4.一种电子设备，包括：

一个或多个处理器；

存储装置，其上存储有一个或多个程序；

当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如权利要求1至3中任一所述的方法。

5.一种计算机可读介质，其上存储有计算机程序，其中，所述计算机程序被处理器执行时实现如权利要求1至3中任一所述的方法。