一种持续集成中的代码文档生成方法、装置及系统制造方法及图纸

本发明专利技术实施例公开了一种持续集成中的代码文档生成方法、装置及系统，包括获取用户提交的代码及代码注释；依据代码判断代码注释是否正确，如果是，则将代码及代码注释存储至代码库，并执行下一步；否则，返回提示信息；获取代码结构及代码注释，将代码结构及代码注释记录至源文件中；依据预先设置的配置文件将源文件生成代码文档。可见，通过对用户提交的代码及代码注释进行检验以保证代码注释与代码的一致性，当检验通过后再依据工作人员提交的代码的代码结构及代码注释生成源文件，将源文件按照预先设置的配置信息生成代码文档。本发明专利技术实施例实现了代码文档的自动生成与及时更新，节约了人力资源、提高了工作效率及代码文档的准确性。

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

The embodiment of the invention discloses a continuous integration code document generation method, device and system, including access to the user submitted code and code comments; according to code judgment code is correct, if it is, then the code and code comments is stored to the code base, and execute the next step; otherwise, the return message; get the code structure and code comments, the code structure and code notes to the source file; according to the preset configuration file will generate code source document. Obviously, by the user's code and code for inspection to ensure the consistency of the comments and code code, when the test is passed according to staff submitted code structure and code generation source files, source files according to preset configuration information to generate code document. The embodiment of the invention realizes the automatic generation and update of the code document, saves the human resources, improves the work efficiency and the accuracy of the code document.

【技术实现步骤摘要】
一种持续集成中的代码文档生成方法、装置及系统
本专利技术实施例涉及持续集成
，特别是涉及一种持续集成中的代码文档生成方法、装置及系统。
技术介绍
持续集成在系统开发的过程中起着非常重要的作用，并且代码文档的输出属于持续集成过程中的最后一步，也就是将代码文档进行发布。代码文档包括每个方法或接口的作用，输入及输出参数的说明等等。在系统开发的过程中，代码文档是非常重要的，完善、详尽的代码文档不仅可以方便上下游模块的开发人员进行交流，也可以为测试人员提供详尽的测试说明，减少不必要的讨论，从而提升工作效率。在将代码文档进行发布之前需要生成相应的代码文档，现有技术中是通过工作人员手动编辑相关信息从而形成代码文档的，并且当对代码进行相应的更改后还需要手动对代码文档进行更新，从而导致代码文档的更新不及时，并在一定程度上造成人力资源浪费、降低工作效率及代码文档的准确性。因此，如何提供一种解决上述问题的持续集成中的代码文档生成方法、装置及系统成为本领域的技术人员目前需要解决的问题。
技术实现思路
本专利技术实施例的目的是提供一种持续集成中的代码文档生成方法、装置及系统，在使用过程中实现了代码文档的自动本文档来自技高网...

【技术保护点】
一种持续集成中的代码文档生成方法，其特征在于，包括：S11：获取用户提交的代码及代码注释；S12：依据所述代码判断所述代码注释是否正确，如果是，则将所述代码及所述代码注释存储至代码库，并进入S13；否则，返回提示信息；S13：获取所述代码的代码结构及所述代码注释，并将所述代码结构及代码注释记录至源文件中；S14：依据预先设置的配置文件将所述源文件生成代码文档。

【技术特征摘要】
1.一种持续集成中的代码文档生成方法，其特征在于，包括：S11：获取用户提交的代码及代码注释；S12：依据所述代码判断所述代码注释是否正确，如果是，则将所述代码及所述代码注释存储至代码库，并进入S13；否则，返回提示信息；S13：获取所述代码的代码结构及所述代码注释，并将所述代码结构及代码注释记录至源文件中；S14：依据预先设置的配置文件将所述源文件生成代码文档。2.根据权利要求1所述的持续集成中的代码文档生成方法，其特征在于，所述方法还包括：将所述代码文档发布到文档服务器上。3.根据权利要求2所述的持续集成中的代码文档生成方法，其特征在于，所述将所述代码文档进行发布的过程具体为：将所述代码文档按照预设方式进行发布。4.根据权利要求2所述的持续集成中的代码文档生成方法，其特征在于，所述预设方式为网页方式或PDF链接的方式。...

【专利技术属性】
技术研发人员：薛昊原，姜文涛，赵祯龙，樊云龙，
申请(专利权)人：郑州云海信息技术有限公司，
类型：发明
国别省市：河南,41