电子设备、技术文档的生成方法及装置制造方法及图纸

本发明专利技术实施例涉及电子技术领域，公开了一种电子设备、技术文档的生成方法及装置。本发明专利技术中，技术文档的生成方法应用于包括至少一代码段的代码文件，技术文档的生成方法包括：读取代码文件，并提取代码段对应的符合预设规则的代码注释；根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项；根据代码段对应的多个注释项生成代码文件对应的技术文档。本发明专利技术实施例还提供了一种技术文档的生成装置及电子设备，相对于现有技术，本发明专利技术实施例可以减少开发人员维护技术文档的工作量，提高效率，并且保证了注释和文档的同步性，降低维护成本。

Method and device for generating electronic equipment and technical document

The embodiment of the invention relates to the field of electronic technology, and discloses a method and a device for generating electronic equipment and technical documents. In the invention, technical document generation method is applied to the code file includes at least one section of the code, including the method of generating technical documentation: read the code file and extract the code corresponding with preset rules code; according to predetermined rules of code is analyzed, and the extraction of multiple annotations code segment according to the technical documents; corresponding code segments corresponding to the multiple annotation of Xiang Shengcheng code file. The embodiment of the invention also provides a technical document generation device and electronic equipment, compared with the prior art, the embodiment of the invention can reduce the developer maintenance technical documentation workload, improve efficiency, and ensure the synchronization of the notes and documents, reduce maintenance cost.

【技术实现步骤摘要】
电子设备、技术文档的生成方法及装置
本专利技术实施例涉及电子
，特别涉及电子设备、技术文档的生成方法及装置。
技术介绍
工程师在开发过程中，基于代码的可读性，需要给代码添加注释，同时需要维护技术文档以便于技术的介绍、说明和推行，因此技术研发需要维护“注释文档”和“技术文档”两种文件。当工程师维护的项目越来越多时，注释和文档的维护就显得尤为重要，它们能帮助工程师更高效、清晰地完成开发任务。在实现本专利技术过程中，专利技术人发现现有技术中至少存在如下问题：1、效率低。由于需要同时维护两种文件，修改更新代码、注释的同时，还需要手动去更新技术文档，重复性工作较多，耗费时间。当项目任务繁琐，常常更新一种文件忘了同步到另一种文件，造成文档和注释的差异，从而影响工程师开发。2、维护成本高，同步性差。传统的技术文档，当更新工程代码时，需要修改注释，同时也需要手动更新技术文档。
技术实现思路
本专利技术实施例的目的在于提供一种电子设备、技术文档的生成方法及装置，可以减少开发人员维护技术文档的工作量，提高效率，并且保证了注释和文档的同步性，降低维护成本。第一方面，本专利技术的实施例提供了一种技术文档的生成方法，应用于包括至少一代码段的代码文件，所述技术文档的生成方法包括：读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。第二方面，本专利技术的实施例提供了一种技术文档的生成装置，包括：应用于包括至少一代码段的代码文件，所述技术文档的生成装置包括：代码注释提取模块，用于读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；代码注释解析模块，用于根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；文档生成模块，用于根据所述多个注释项生成所述代码文件对应的技术文档。第三方面，本专利技术的实施例提供了一种电子设备，包括：至少一个处理器；以及，与所述至少一个处理器通信连接的存储器；其中，所述存储器存储有可被所述一个处理器执行的指令，所述指令被被所述至少一个处理器执行，以使所述至少一个处理器能够：读取所述代码文件，并提取所述代码段对应的符合预设规则的代码注释；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。第四方面，本专利技术实施例提供了一种计算机程序产品，包括存储在非暂态计算机可读存储介质上的计算机程序，计算机程序包括程序指令，当程序指令被计算机执行时，使计算机执行本专利技术实施例的上述技术文档的生成方法。第五方面，本专利技术实施例提供了一种非易失性计算机存储介质，存储有计算机可执行指令，计算机可执行指令用于执行本专利技术实施例上述技术文档的生成方法。本专利技术实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需要修改注释，技术文档会根据代码注释自动生成，而不需要手动去更新技术文档。这样减少开发人员的工作量，提高了效率，并且保证了注释和文档的同步性，降低了维护成本。另外，在所述根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项中，具体包括：检测所述代码注释中的多个预设关键字，并将多个所述预设关键字绑定的数据分别提取出来作为多个所述注释项。本实施例提供了根据预设规则对代码注释进行解析，并提取代码段对应的多个注释项的一种具体实现方式。另外，在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档中，具体包括：获取预存的模板文件；所述模板文件中包括每个所述预设关键字对应的填充区；将每个所述注释项填写至每个所述注释项绑定的预设关键字对应的填充区中。本实施例提供了根据代码段对应的多个注释项生成代码文件对应的技术文档的一种具体实现方式。另外，所述代码段的数目为多个，且每个所述代码段对应的多个注释项中包括一个代码段名称；在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档之后，还包括：根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录。通过建立代码段索引目录便于开发人员在技术文档中查找每个代码段对应的多个注释项。另外，每个所述代码段对应的多个注释项中还包括代码段类型；在所述根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录之后，还包括：根据每个所述代码段的代码段类型，将所述代码段索引目录划分为分别对应于多种代码段类型的多个索引区。这样，可以将同一类型的代码段划在一个索引区内，在代码段的数目为多时，便于对多个代码段管理，也方便查找代码段。附图说明一个或多个实施例通过与之对应的附图中的图片进行示例性说明，这些示例性说明并不构成对实施例的限定，附图中具有相同参考数字标号的元件表示为类似的元件，除非有特别申明，附图中的图不构成比例限制。图1是根据本专利技术第一实施例的技术文档的生成方法流程图；图2是根据本专利技术第二实施例的技术文档的生成方法流程图；图3是根据本专利技术第二实施例中的代码注释图；图4是根据本专利技术第二实施例中的技术文档示意图；图5是根据本专利技术第三实施例的技术文档的生成方法流程图；图6是根据本专利技术第三实施例中的技术文档示意图；图7是根据本专利技术第四实施例的技术文档的生成装置的结构示意图；图8是根据本专利技术第五实施例的技术文档的生成装置的结构示意图；图9是根据本专利技术第六实施例的技术文档的生成装置的结构示意图；图10是根据本专利技术第七实施例的电子设备的结构示意图。具体实施例为使本专利技术实施例的目的、技术方案和优点更加清楚，下面将结合附图对本专利技术的各实施例进行详细的阐述。然而，本领域的普通技术人员可以理解，在本专利技术各实施例中，为了使读者更好地理解本申请而提出了许多技术细节。但是，即使没有这些技术细节和基于以下各实施例的种种变化和修改，也可以实现本申请所要求保护的技术方案。本专利技术的第一实施例涉及一种技术文档的生成方法，其流程如图1所示，具体如下：在步骤101中，读取代码文件。其中，本实施例中的代码文件中包括至少一代码段。一般而言，一个代码文件中会包括多个代码段，每个代码段用于实现一种功能。在步骤102中，提取代码段对应的代码注释，其中代码注释符合预设规则。具体地说，该预设规则可以为工程师写入代码注释时设定的规则，比如说：代码注释的每一段为一个注释项，并且，第一个注释项(即第一段)表示代码段名称，第二个注释项(即第二段)表示代码段撰写日期，第三个注释项(即第三段)表示代码段版本等等。在步骤103中，根据预设规则对代码注释进行解析并提取代码段对应的多个注释项。具体的说，提取的多个注释项中可以包括代码段名称、代码段描述、代码段类参数、代码作者以及代码链接地址等等。在步骤104中，根据代码段对应的多个注释项生成代码文件对应的技术文档。具体地说，可以按照预设的规则自动生成代码文件对应的技术文档，其中，该技术文档中包含从代码注释中解析出来的该代码段对应的每个注释项。本实施例相对于现有技术而言，可以根据代码段对应的注释项自动生成技术文档，开发者只需要根据一套通用的格式来维护代码注释，当更新工程代码时，只需本文档来自技高网...

【技术保护点】
一种技术文档的生成方法，其特征在于，应用于包括至少一代码段的代码文件，所述技术文档的生成方法包括：读取所述代码文件，并提取所述代码段对应的代码注释，其中，所述代码注释符合预设规则；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。

【技术特征摘要】
1.一种技术文档的生成方法，其特征在于，应用于包括至少一代码段的代码文件，所述技术文档的生成方法包括：读取所述代码文件，并提取所述代码段对应的代码注释，其中，所述代码注释符合预设规则；根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项；根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档。2.根据权利要求1所述的技术文档的生成方法，其特征在于，在所述根据所述预设规则对所述代码注释进行解析，并提取所述代码段对应的多个注释项中，具体包括：检测所述代码注释中的多个预设关键字，并将多个所述预设关键字绑定的数据分别提取出来作为多个所述注释项。3.根据权利要求2所述的技术文档的生成方法，其特征在于，在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档中，具体包括：获取预存的模板文件；所述模板文件中包括每个所述预设关键字对应的填充区；将每个所述注释项填写至每个所述注释项绑定的预设关键字对应的填充区中。4.根据权利要求2所述的技术文档的生成方法，其特征在于，每个所述预设关键字以前缀形式或者后缀形式绑定于每个所述预设关键字对应的注释项。5.根据权利要求1所述的技术文档的生成方法，其特征在于，所述代码段的数目为多个，且每个所述代码段对应的多个注释项中包括一个代码段名称；在根据所述代码段对应的多个注释项生成所述代码文件对应的技术文档之后，还包括：根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录。6.根据权利要求5所述的技术文档的生成方法，其特征在于，每个所述代码段对应的多个注释项中还包括代码段类型；在所述根据每个所述代码段的代码段名称建立所述技术文档的代码段索引目录之后，还包括：根据每个所述代码段的代码段类型，将所述代码段索引目录划分为分别对应于多种代码段类型的多个索引区。7.根据权利要求1所述的技术文档的生成方法，其特征在于，每个所述代码段对应的多个注释项中包括一个代码段名称、一个代码段描述以及至少一个代码段类参数。8.根据权利要求7所述的技术文档的生成方法，其特征在于，每个所述代码段类参数包括参数类型、参数名称以及参数解释。9.一种技术文档的生成装置，其特征在于，应用于包括至...

【专利技术属性】
技术研发人员：李欣书林，丁晓燕，
申请(专利权)人：乐视致新电子科技天津有限公司，
类型：发明
国别省市：天津,12