Method and system for automatically generating development document based on code annotation

Abstract

The invention discloses a method and system for automatically generating a development document based on code annotation, and the method is characterized in that the method comprises the following steps: installing webpack and react-stylegidist for constructing a project; creating and configuring a styleguide.config.js file under a same-level directory of a webpack configuration file, classifyingcomponents of a project, putting the components which need to be exposed to the outside under a views directory, and obtaining .jsx file through a wildcard select\*; introducing a public style and a special style into a project through a package file, conducting global setting on an antd component library, and integrating redux data; configuring a script in a package.json; in webpack configuration, respectively adding and setting different interface addresses for different environments through env environment variables, and then normally accessing an interface through an agent. The effects ofautomatically generating code annotations of components, writing demo and corresponding instructions for various use scenes, attaching a demo source code, modifying the source code and previewing thedemo in real time are achieved.

Description

Technical field [0001] The invention relates to the field of service discovery of computer processing technology, in particular to a method and system for automatically generating development documents based on code comments. Background technique [0002] To develop a React project, we need to develop many React components, especially some public components. After developing a component, we will face the following problems: [0003] A colleague of the project team wants to use the component, but doesn’t know how to use it. He must go to the page where the component has been used before, or directly look at the component source code, which is troublesome and time-consuming, and may not be able to figure it out; a new joiner Colleagues in the project team want to familiarize themselves with the project and see where there are common components. If there are some demo examples at this time, it will be very intuitive; even the people who develop the components themselves will forget ea...

AI Technical Summary

Problems solved by technology

[0006] 1. Through the ordinary markdown document generation system, it can only meet the requirements of writing documents, and the usability is relatively low

[0007] 2. Redemo is a set of React component documentation system developed by Tencent's front-end team, but it is difficult to integrate with local projects, and there is a lack of documentation

[0008] 3. Bi Sheng is a set of document generator written by ant-design (Ali team). It uses relatively few documents and is difficult to understand. In addition, it is difficult to combine with local projects.

Images