电子设备、技术文档的生成方法及装置与流程

本发明实施例涉及电子技术领域，特别涉及电子设备、技术文档的生成方法及装置。

背景技术：

工程师在开发过程中，基于代码的可读性，需要给代码添加注释，同时需要维护技术文档以便于技术的介绍、说明和推行，因此技术研发需要维护“注释文档”和“技术文档”两种文件。当工程师维护的项目越来越多时，注释和文档的维护就显得尤为重要，它们能帮助工程师更高效、清晰地完成开发任务。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：

1、效率低。由于需要同时维护两种文件，修改更新代码、注释的同时，还需要手动去更新技术文档，重复性工作较多，耗费时间。当项目任务繁琐，常常更新一种文件忘了同步到另一种文件，造成文档和注释的差异，从而影响工程师开发。

2、维护成本高，同步性差。传统的技术文档，当更新工程代码时，需要修改注释，同时也需要手动更新技术文档。

技术实现要素：

本发明实施例的目的在于提供一种电子设备、技术文档的生成方法及装置，可以减少开发人员维护技术文档的工作量，提高效率，并且保证了注释和文档的同步性，降低维护成本。

第一方面，本发明的实施例提供了一种技术文档的生成方法，应用于包括至少一代码段的代码文件，所述技术文档的生成方法包括：读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。

第二方面，本发明的实施例提供了一种技术文档的生成装置，包括：应用于包括至少一代码段的代码文件，所述技术文档的生成装置包括：代码注释提取模块，用于读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；代码注释解析模块，用于根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；文档生成模块，用于根据所述多个注释项生成所述代码文件对应的技术文档。

第三方面，本发明的实施例提供了一种电子设备，包括：至少一个处理器；以及，与所述至少一个处理器通信连接的存储器；其中，所述存储器存储有可被所述一个处理器执行的指令，所述指令被被所述至少一个处理器执行，以使所述至少一个处理器能够：读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。

第四方面，本发明实施例提供了一种计算机程序产品，包括存储在非暂态计算机可读存储介质上的计算机程序，计算机程序包括程序指令，当程序指令被计算机执行时，使计算机执行本发明实施例的上述技术文档的生成方法。

第五方面，本发明实施例提供了一种非易失性计算机存储介质，存储有计算机可执行指令，计算机可执行指令用于执行本发明实施例上述技术文档的生成方法。

本发明实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

另外，在所述根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项中，具体包括：检测所述代码注释中的多个预设关键字，并将多个所述预设关键字绑定的数据分别提取出来作为多个所述注释项。本实施例提供了根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项的一种具体实现方式。

另外，在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档中，具体包括：获取预存的模板文件；所述模板文件中包括每个所述预设关键字对应的填充区；将每个所述注释项填写至每个所述注释项绑定的预设关键字对应的填充区中。本实施例提供了根据代码段对应的多个注释项生成代码文件对应的技术文档的一种具体实现方式。

另外，所述代码段的数目为多个，且每个所述代码段对应的多个注释项中包括一个代码段名称；在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档之后，还包括：根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录。通过建立代码段索引目录便于开发人员在技术文档中查找每个代码段对应的多个注释项。

另外，每个所述代码段对应的多个注释项中还包括代码段类型；在所述根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录之后，还包括：根据每个所述代码段的代码段类型，将所述代码段索引目录划分为分别对应于多种代码段类型的多个索引区。这样，可以将同一类型的代码段划在一个索引区内，在代码段的数目为多时，便于对多个代码段管理，也方便查找代码段。

附图说明

一个或多个实施例通过与之对应的附图中的图片进行示例性说明，这些示例性说明并不构成对实施例的限定，附图中具有相同参考数字标号的元件表示为类似的元件，除非有特别申明，附图中的图不构成比例限制。

图1是根据本发明第一实施例的技术文档的生成方法流程图；

图2是根据本发明第二实施例的技术文档的生成方法流程图；

图3是根据本发明第二实施例中的代码注释图；

图4是根据本发明第二实施例中的技术文档示意图；

图5是根据本发明第三实施例的技术文档的生成方法流程图；

图6是根据本发明第三实施例中的技术文档示意图；

图7是根据本发明第四实施例的技术文档的生成装置的结构示意图；

图8是根据本发明第五实施例的技术文档的生成装置的结构示意图；

图9是根据本发明第六实施例的技术文档的生成装置的结构示意图；

图10是根据本发明第七实施例的电子设备的结构示意图。

具体实施例

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合附图对本发明的各实施例进行详细的阐述。然而，本领域的普通技术人员可以理解，在本发明各实施例中，为了使读者更好地理解本申请而提出了许多技术细节。但是，即使没有这些技术细节和基于以下各实施例的种种变化和修改，也可以实现本申请所要求保护的技术方案。

本发明的第一实施例涉及一种技术文档的生成方法，其流程如图1所示，具体如下：

在步骤101中，读取代码文件。其中，本实施例中的代码文件中包括至少一代码段。一般而言，一个代码文件中会包括多个代码段，每个代码段用于实现一种功能。

在步骤102中，提取代码段对应的代码注释，其中代码注释符合预设规则。具体地说，该预设规则可以为工程师写入代码注释时设定的规则，比如说：代码注释的每一段为一个注释项，并且，第一个注释项(即第一段)表示代码段名称，第二个注释项(即第二段)表示代码段撰写日期，第三个注释项(即第三段)表示代码段版本等等。

在步骤103中，根据预设规则对代码注释进行解析并提取代码段对应的多个注释项。具体的说，提取的多个注释项中可以包括代码段名称、代码段描述、代码段类参数、代码作者以及代码链接地址等等。

在步骤104中，根据代码段对应的多个注释项生成代码文件对应的技术文档。具体地说，可以按照预设的规则自动生成代码文件对应的技术文档，其中，该技术文档中包含从代码注释中解析出来的该代码段对应的每个注释项。

本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

本发明的第二实施例涉及一种技术文档的生成方法。第二实施例对第一实施例进行了细化，细化之处在于：提供了提取代码段对应的多个注释项以及生成代码文件对应的技术文档的具体实现方式。本实施例中技术文档的生成方法流程如图2所示，具体如下：

在步骤201中，读取代码文件。其中，本实施例中的代码文件中包括至少一代码段。一般而言，一个代码文件中会包括多个代码段，每个代码段用于实现一种功能。

在步骤202中，提取代码段对应的符合预设规则的代码注释。具体地说，该预设规则可以为工程师写入代码注释时设定的规则。比如说：代码注释的每一段为一个注释项，并且，第一个注释项(即第一段)表示代码段名称，第二个注释项(即第二段)表示代码段撰写日期，第三个注释项(即第三段)表示代码段版本等等，如图3所示。

在步骤203中，根据预设规则对代码注释进行解析并提取代码段对应的多个注释项。具体的说，提取的每个代码段对应的多个注释项中包括一个代码段名称、一个代码段描述以及至少一个代码段类参数，实际应用中还可以包括代码作者以及代码链接地址等等。比如说，如图3中所示的代码段中，代码段名称为“对话框”，代码段描述为“dialog”，代码段类参数为“{obiect}opts参数”“{number}opts.width对话框宽度，默认300px”“{number}opts.height对话框高度，默认自动”等等。其中，每个代码段类参数包括参数类型、参数名称以及参数解释，比如在代码段类参数“{obiect}opts参数”中，参数类型为“obiect”、参数名称为“opts”、参数解释为“参数”。本步骤中包含子步骤2031和子步骤2032。

在子步骤2031中，检测代码注释中的多个预设关键字。具体地说，代码注释中的多个预设关键字可以为每一个注释项中的预设关键字，比如说：代码段描述“dialog”对应的预设关键字为“constructs”；代码段类参数“{obiect}opts参数”“{number}opts.width对话框宽度，默认300px”“{number}opts.height对话框高度，默认自动”对应的预设关键字为“param”等等。

在子步骤2032中，将多个预设关键字绑定的数据分别提取出来作为多个注释项。比如说，预设关键字“constructs”绑定的数据内容为“dialog”，本实施例中，每个预设关键字可以以前缀形式或者后缀形式绑定于每个预设关键字对应的注释项，比如图3中注释项“@date2015.04.30”中的预设关键字“date”是以前缀的形式绑定对应的注释项。

在步骤204中，根据代码段对应的多个注释项生成代码文件对应的技术文档。具体地说本步骤包含本步骤中包含子步骤2041和子步骤2042。

在子步骤2041中，获取预存的模板文件。具体地说，模板文件中包括每个预设关键字对应的填充区。具体地说，可以在后台建立注释项中各个预设关键字与填充区的对应关系，比如说模板文件中的“描述”对应注释项的预设关键字“constructs”，模板文件中的“作者”对应注释项中的预设关键字“author”等等。

在子步骤2042中，将每个注释项填写至每个注释项绑定的预设关键字对应的填充区中。具体地说，将每个预设关键字对应的注释项的内容填充到相应的填充区，比如说，以预设关键字“constructs”为例，其对应的注释项的内容为“dialog”，将“dialog”填充到模板文件中“描述”对应的填充区中。

优选的，本实施方式中也可以将预设关键字以中文的形式显示显示，比如说，预设关键字“constructs”在模板文件显示为“描述”，预设关键字“constructs”绑定的内容在模板文件显示为“对话框”，如图4中所示。

本实施例相对于第一实施例而言，提供了根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项以及根据代码段对应的多个注释项生成代码文件对应的技术文档的一种具体实现方式，且计算简单，易于实现。

本发明的第三实施例涉及一种技术文档的生成方法。第三实施例在第一实施例的基础上作了改进，改进之处在于：在生成代码文件对应的技术文档之后还可以建立代码段索引目录并划分索引区，本实施例中技术文档的生成方法的流程如图5所示，具体如下：

在步骤501中，读取代码文件。具体地说，本实施例中的代码文件中包括多个代码段，每个代码段用于实现一种功能。且每个代码段对应的多个注释项中包括一个代码段名称以及代码段类型，需要说明的是，在实际应用中，每个代码段对应的多个注释项中还可以包括一个代码段描述、至少一个代码段类参数、代码作者以及代码链接地址等等。其中，每个代码段类参数包括参数类型、参数名称以及参数解释。

在步骤502中，提取代码段对应的符合预设规则的代码注释。具体地说，提取每个代码段对应的符合预设规则的代码注释，该预设规则可以为工程师写入代码注释时设定的规则，比如说：代码注释的每一段为一个注释项，并且，第一个注释项(即第一段)表示代码段名称，第二个注释项(即第二段)表示代码段撰写日期，第三个注释项(即第三段)表示代码段版本等等。

在步骤503中，根据预设规则对代码注释进行解析并提取代码段对应的多个注释项。具体地说，提取的每个代码段对应的多个注释项中包括一个代码段名称、一个代码段描述以及至少一个代码段类参数，还可以包括代码作者以及代码链接地址等等。

在步骤504中，根据代码段对应的多个注释项生成代码文件对应的技术文档。具体地说，可以按照预设的规则自动生成代码文件对应的技术文档，其中，该技术文档中包含代码段中的每个注释项以及每个注释项中对应的多个参数。

在步骤505中，根据每个代码段的代码段名称建立技术文档的代码段索引目录。具体地说，本实施方式中的每个代码段都包括一个代码段名称，将每个代码段的名称提取出来建成一个目录。如图6所示，图中“audio”“calendar”“cutpicture”“drag”等即为代码段名称，这些代码段名称组成的目录即为代码段索引目录，当点开目录中的其中一个代码段名称时，即可以查看该代码段名称对应的代码段的相关注释。

在步骤506中，根据每个代码段的代码段类型，将代码段索引目录划分为分别对应于多种代码段类型的多个索引区。具体地说，可以根据每个代码段名称对应的注释项中的关于代码段类型的定义来判断代码段的类型，并将属于同一种类型的代码段划分为一个索引区。比如说：“audio”“calendar”“cutpicture”“drag”等这些代码段名称所代表的代码段类型相同，都属于“组件”类，则可以将这些代码段的索引目录划分在一个索引区内，索引区的名称为“组件”；“core.bassclass”“util.addtimetourl”“sle.g3”等这些代码段名称所代表的代码段类型相同，都属于“通用”类，则可以将这些代码段的索引目录划分在一个索引区内，索引区的名称为“通用(ro)”。如图6中所示，图6中示出了2个索引区“组件”“ro”的情况。

本实施例相对于第一实施例而言，通过建立代码段索引目录便于开发人员在技术文档中查找每个代码段对应的多个注释项。将同一类型的代码段划在一个索引区内，这样在代码段的数目为多时，便于对多个代码段管理，也方便查找代码段。

上面各种方法的步骤划分，只是为了描述清楚，实现时可以合并为一个步骤或者对某些步骤进行拆分，分解为多个步骤，只要包括相同的逻辑关系，都在本专利的保护范围内；对算法中或者流程中添加无关紧要的修改或者引入无关紧要的设计，但不改变其算法和流程的核心设计都在该专利的保护范围内。

本发明第四实施例涉及一种技术文档的生成装置，应用于包括至少一代码段的代码文件，所本实施例中技术文档的生成装置包括：代码注释提取模块1、代码注释解析模块2和文档生成模块3，如图7所示。

代码注释提取模块1用于读取代码文件，并提取代码段对应的代码注释，其中，代码注释符合预设规则。

代码注释解析模块2用于根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项。

文档生成模块3用于根据多个注释项生成代码文件对应的技术文档。

本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，文档生成模块会根据代码注释自动生成新的技术文档，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

不难发现，本实施例为与第一实施例相对应的装置实施例，本实施例可与第一实施例互相配合实施。第一实施例中提到的相关技术细节在本实施例中依然有效，为了减少重复，这里不再赘述。相应地，本实施例中提到的相关技术细节也可应用在第一实施例中。

值得一提的是，本实施例中所涉及到的各模块均为逻辑模块，在实际应用中，一个逻辑单元可以是一个物理单元，也可以是一个物理单元的一部分，还可以以多个物理单元的组合实现。此外，为了突出本发明的创新部分，本实施例中并没有将与解决本发明所提出的技术问题关系不太密切的单元引入，但这并不表明本实施例中不存在其它的单元。

本发明第五实施例涉及一种技术文档的生成装置。第五实施例在第四实施例的基础上作了改进，改进之处在于：在本实施例中，文档生成模块3包括模板获取单元31和填充单元32，如图8所示。

具体地说，本实施例中的代码注释解析模块2还用于检测代码注释中的多个预设关键字，并将多个预设关键字绑定的数据分别提取出来作为多个注释项。

模板获取单元31用于获取预存的模板文件。其中，模板文件中包括每个预设关键字对应的填充区。

填充单元32用于将每个注释项填写至注释项绑定的预设关键字对应的填充区中。

本实施例相对于第五实施例而言，通过模板获取单元31和填充单元32实现根据代码段对应的多个注释项自动生成代码文件对应的技术文档，且计算简单，易于实现。

由于第二实施例与本实施例相互对应，因此本实施例可与第二实施例互相配合实施。第二实施例中提到的相关技术细节在本实施例中依然有效，在第二实施例中所能达到的技术效果在本实施例中也同样可以实现，为了减少重复，这里不再赘述。相应地，本实施例中提到的相关技术细节也可应用在第二实施例中。

本发明第六实施例涉及一种技术文档的生成装置。第六实施例在第四实施例的基础上作了改进，改进之处在于：在本实施例中的技术文档的生成装置还包括索引目录建立模块4和索引区划分模块5，如图9所示。

具体地说，本实施例中的代码段的数目可以为多个，且每个代码段对应的多个注释项中包括一个代码段名称以及代码段类型。

索引目录建立模块4用于根据每个代码段的代码段名称建立技术文档的代码段索引目录。

索引区划分模块5用于根据每个代码段的代码段类型，将代码段索引目录划分为分别对应于多种代码段类型的多个索引区。

本实施例相对于第四实施例而言，通过索引目录建立代码段索引目录便于开发人员在技术文档中查找每个代码段对应的多个注释项。通过索引区划分模块将同一类型的代码段划在一个索引区内，这样在代码段的数目为多时，便于对多个代码段管理，也方便查找代码段。

不难发现，本实施例为与第三实施例相对应的装置实施例，本实施例可与第三实施例互相配合实施。第三实施例中提到的相关技术细节在本实施例中依然有效，为了减少重复，这里不再赘述。相应地，本实施例中提到的相关技术细节也可应用在第三实施例中。

本发明第七实施例涉及一种电子设备，如图10所示，该电子设备包括：至少一个处理器6以及与至少一个处理器6通信连接的存储器7，图10中以一个处理器6为例。

该电子设备还可以包括：输入装置8和输出装置9。

处理器6、存储器7、输入装置8和输出装置9可以通过总线或者其他方式连接，图10中以通过总线连接为例。

存储器7作为一种非暂态计算机可读存储介质，可用于存储非暂态软件程序、非暂态计算机可执行程序以及模块，如本发明实施例中的技术文档的生成方法对应的程序指令/模块(例如，附图7中所示的代码注释提取模块1、代码注释解析模块2和文档生成模块3)。处理器6通过运行存储在存储器7中的非暂态软件程序、指令以及模块，从而执行服务器的各种功能应用以及数据处理，即实现上述方法实施例中的技术文档的生成方法。

存储器7可以包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需要的应用程序；存储数据区可存储根据列表项操作的处理装置的使用所创建的数据等。此外，存储器7可以包括高速随机存取存储器，还可以包括非暂态存储器，例如至少一个磁盘存储器件、闪存器件、或其他非暂态固态存储器件。在一些实施例中，存储器7可选包括相对于处理器6远程设置的存储器，这些远程存储器可以通过网络连接至用于技术文档的生成方法的处理器7。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

输入装置8可接收输入的数字或字符信息，以及产生与列表项操作的处理装置的用户设置以及功能控制有关的键信号输入。输出装置9可包括显示屏等显示设备。

本实施例中，当存储器7中存储的一个或多个模块(例如，附图7中所示的代码注释提取模块1、代码注释解析模块2和文档生成模块3)被所述一个或者多个处理器6执行时，处理器6执行上述任意方法实施例中的技术文档的生成方法，即执行：读取代码文件，并提取代码段对应的符合预设规则的代码注释；根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项；根据代码段对应的多个注释项生成代码文件对应的技术文档。

上述产品可执行本申请实施例所提供的方法，具备执行方法相应的功能模块和有益效果。未在本实施例中详尽描述的技术细节，可参见本申请实施例所提供的方法。

本发明实施例的电子设备以多种形式存在，包括但不限于：

(1)移动通信设备:这类设备的特点是具备移动通信功能，并且以提供话音、数据通信为主要目标。这类终端包括:智能手机(例如iphone)、多媒体手机、功能性手机，以及低端手机等。

(2)超移动个人计算机设备:这类设备属于个人计算机的范畴，有计算和处理功能，一般也具备移动上网特性。这类终端包括:pda、mid和umpc设备等，例如ipad。

(3)便携式娱乐设备:这类设备可以显示和播放多媒体内容。该类设备包括:音频、视频播放器(例如ipod)，掌上游戏机，电子书，以及智能玩具和便携式车载导航设备。

本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

本发明第八实施例涉及一种非易失性计算机存储介质，该计算机存储介质存储有计算机可执行指令，该计算机可执行指令可执行上述任意方法实施例中的技术文档的生成方法。

本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

本发明第九实施例涉及一种计算机程序产品，能够执行上述任意方法实施例中的技术文档的生成方法。

本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。

本领域技术人员可以理解实现上述实施例方法中的全部或部分步骤是可以通过程序来指令相关的硬件来完成，该程序存储在一个存储介质中，包括若干指令用以使得一个设备(可以是单片机，芯片等)或处理器(processor)执行本申请各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：u盘、移动硬盘、只读存储器(rom，read-onlymemory)、随机存取存储器(ram，randomaccessmemory)、磁碟或者光盘等各种可以存储程序代码的介质。

本领域的普通技术人员可以理解，上述各实施例是实现本发明的具体实施例，而在实际应用中，可以在形式上和细节上对其作各种改变，而不偏离本发明的精神和范围。