[发明专利]电子设备、技术文档的生成方法及装置

说明书

技术领域

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

背景技术

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

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

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

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

发明内容

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

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

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

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

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

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

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

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

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

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