Method, device and system for generating code documents in continuous integration

Abstract

Embodiments of the invention disclose a method, device and system for generating code documents in continuous integration. The method comprises the following steps of: obtaining a code and a code annotation submitted by a user; judging whether the code annotation is correct or not according to the code; if the judging result is positive, storing the code and the code annotation into a code library and executing the next step; if the judging result is negative, returning prompt information; obtaining a code structure and the code annotation, and recording the code structure and the code annotation into a source file; and generating the source file into a code document according to a preset configuration file. According to the method, the code and the code annotation submitted by the users are verified to ensure the consistency between the code annotation and the code; after the verification passes, the source file is generated according to the code structure and the code annotation, submitted by a worker, of the code; and the source file is generated into the code document according to the preset configuration information. According to the method, device and system disclosed by the invention, the automatic generation and timely updating of code documents are realized, so that the manpower resources are saved, and the working efficiency and the correctness of the code documents are improved.

Description

technical field [0001] The embodiments of the present invention relate to the technical field of continuous integration, in particular to a method, device and system for generating code documents in continuous integration. Background technique [0002] Continuous integration plays a very important role in the process of system development, and the output of code documentation is the last step in the continuous integration process, that is, the release of code documentation. The code documentation includes the function of each method or interface, descriptions of input and output parameters, and so on. In the process of system development, code documentation is very important. Perfect and detailed code documentation can not only facilitate communication between developers of upstream and downstream modules, but also provide testers with detailed test instructions to reduce unnecessary discussions, thereby Increase work efficiency. [0003] Before the code document is publis...

AI Technical Summary

Problems solved by technology

[0003] Before the code document is published, the corresponding code document needs to be generated. In the prior art, the staff manually edits the relevant information to form the code document, and when the corresponding changes are made to the code, the code document needs to be manually updated. As a result, the update of code documents is not timely, and to a certain extent, it causes waste of human resources, reduces work efficiency and the accuracy of code documents

Images