Document generation method and system, equipment and medium

A document generation and equipment technology, applied in the direction of creating/generating source code, program files, software maintenance/management, etc., can solve the problems of cumbersome document formation process, low efficiency, affecting software efficiency, etc., and achieve the effect of shortening the document generation time

Inactive Publication Date: 2019-03-19
RUN TECH CO LTD BEIJING
View PDF9 Cites 11 Cited by
  • Summary
  • Abstract
  • Description
  • Claims
  • Application Information

AI Technical Summary

Problems solved by technology

At present, in the development process of web software projects, the front-end and back-end developers usually define the document form together, and the development manual is mostly implemented by handwriting. The document formation process is cumbersome and inefficient, which seriously affects the efficiency of software project development

Method used

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
View more

Image

Smart Image Click on the blue labels to locate them in the text.
Viewing Examples
Smart Image
  • Document generation method and system, equipment and medium
  • Document generation method and system, equipment and medium
  • Document generation method and system, equipment and medium

Examples

Experimental program
Comparison scheme
Effect test

Embodiment 1

[0022] figure 1 It is a flow chart of the steps of a document generation method provided in Embodiment 1 of the present invention. This embodiment is applicable to the automatic generation of software documents, and the method can be executed by a document generation system. The hardware implementation specifically includes the following steps:

[0023] Step 101, extracting model classes included in the target development software.

[0024] Among them, the target development software can be newly developed or original software that lacks software documentation, and the model class can be a data class in the model layer in the target development software, which can be used to set or obtain data attributes, and can also be used to control data processing.

[0025] Specifically, it is possible to obtain the code files of all classes in the target development software, determine whether there is a data class in the model layer or a class for setting or obtaining data, and if the...

Embodiment 2

[0036] figure 2 It is a flow chart of the steps of a document generating method provided in Embodiment 2 of the present invention. This embodiment is an optional solution proposed on the basis of the foregoing embodiments. see figure 2 , the document generation method provided by the embodiment of the present invention includes:

[0037] Step 201, extract configuration parameters in the target development software, and obtain model classes associated with the configuration parameters.

[0038] Step 202, determine whether the first programming code constituting the model class contains interface information and annotation information.

[0039] Wherein, the first programming code may be the constituent code of the data class in the model layer, the interface information may be the information containing the interface keyword Interface, and the annotation information may be the information containing the annotation keyword @.

[0040] Specifically, you can obtain the compos...

Embodiment 3

[0070] image 3 It is a schematic structural diagram of a document generation system provided in Embodiment 3 of the present invention. The document generation system provided in the embodiment of the present invention can execute the document generation method provided in any embodiment of the present invention, and has corresponding functional modules and beneficial effects such as image 3 As shown, the system includes: an extraction module 301 and a document generation module 302 .

[0071] An extraction module 301, configured to extract the model classes contained in the target development software;

[0072] The document generation module 302 is configured to generate a corresponding development instruction document according to the programming codes constituting the model class if the model class meets the document generation requirements.

[0073] In the technical solution of this embodiment, the model class of the target development software is obtained by the extrac...

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

PUM

No PUM Login to view more

Abstract

The invention discloses a document generation method and system, equipment and a medium. The method includes extracting a model class contained in the target development software; and if the model class meets the document generation requirement, generating a corresponding development instruction document according to programming codes forming the model class. According to the document generation method provided by the embodiment of the invention, the automatic generation of the software document is realized, the manual generation of the document in the software development project is avoided,the development time is shortened, and the development efficiency is improved.

Description

technical field [0001] The embodiments of the present invention relate to the technical field of computer applications, and in particular, to a document generation method, system, device and medium. Background technique [0002] Software development documentation is an essential and important material in the process of software development and later operation and maintenance. The existence of software development documentation can improve the efficiency of software development and ensure the quality of software development. In the development process of web software projects, due to the separate development of front-end and back-end, front-end developers need to generate corresponding development documentation according to the front-end functions, and back-end developers can implement corresponding background logic according to the development documentation. The existence of development documentation guarantees The front-end and back-end functions are consistent. [0003] W...

Claims

the structure of the environmentally friendly knitted fabric provided by the present invention; figure 2 Flow chart of the yarn wrapping machine for environmentally friendly knitted fabrics and storage devices; image 3 Is the parameter map of the yarn covering machine
Login to view more

Application Information

Patent Timeline
no application Login to view more
Patent Type & Authority Applications(China)
IPC IPC(8): G06F8/73G06F8/30
CPCG06F8/30G06F8/73
Inventor 万月亮丁洁冰火一莽
Owner RUN TECH CO LTD BEIJING
Who we serve
  • R&D Engineer
  • R&D Manager
  • IP Professional
Why Eureka
  • Industry Leading Data Capabilities
  • Powerful AI technology
  • Patent DNA Extraction
Social media
Try Eureka
PatSnap group products

Browse by: Latest US Patents, China's latest patents, Technical Efficacy Thesaurus, Application Domain, Technology Topic.

© 2024 PatSnap. All rights reserved.Legal|Privacy policy|Modern Slavery Act Transparency Statement|Sitemap