Electronic equipment and method and device for generating technical document

Abstract

The embodiment of the invention relates to the technical field of electrons, and discloses electronic equipment and a method and device for generating a technical document. In the invention, the method for generating the technical document is applied to a code file comprising at least one code segment; and the method for generating the technical document comprises the steps of: reading the code file, and extracting code comments which correspond to the code segment and accord with a preset rule; according to the preset rule, carrying out parsing on the code comments, and extracting a plurality of comment items corresponding to the code segment; and according to the plurality of comment items corresponding to the code segment, generating the technical document corresponding to the code file. The embodiment of the invention further provides the device for generating the technical document and the electronic equipment. Compared with the prior art, according to the electronic equipment and the method and device for generating the technical document, which are disclosed by the embodiment of the invention, the workload for a developer to maintain the technical document can be reduced, efficiency is improved, synchronism of the comments and the document is ensured, and maintenance cost is reduced.

Description

technical field [0001] The embodiments of the present invention relate to the field of electronic technology, and in particular, to electronic equipment and a method and device for generating technical documents. Background technique [0002] During the development process, engineers need to add comments to the code based on the readability of the code. At the same time, they need to maintain technical documents to facilitate the introduction, description and implementation of the technology. document. When engineers maintain more and more projects, the maintenance of comments and documents is particularly important. They can help engineers complete development tasks more efficiently and clearly. [0003] In the course of realizing the present invention, the inventor finds that there are at least the following problems in the prior art: [0004] 1. Low efficiency. Due to the need to maintain two kinds of files at the same time, while modifying and updating the code and co...

AI Technical Summary

Problems solved by technology

[0004] 1. Low efficiency

Due to the need to maintain two kinds of files at the same time, while modifying and updating codes and comments, it is also necessary to manually update technical documents, which is more repetitive and time-consuming

When the project tasks are cumbersome, one kind of file is often updated and forgotten to be synchronized to another file, resulting in differences in documents and comments, which affects the development of engineers

[0005] 2. High maintenance cost and poor synchronization

Images