CN114637532A - Method for automatically obtaining comments and generating interface document according to fields - Google Patents

Abstract

A method for automatically generating an interface document according to a field acquisition comment comprises the following steps: the method comprises the following steps: adding a comment for describing a field of a class source file of Java to the field; step two: according to fields of class source files of Java, a builder design mode is used, and according to naming rules of field names, a chain calling method which is the same as the field names is generated; step three: calling a chain method which is the same as the field name according to the field required by the interface document to define the interface document; step four: and acquiring a field corresponding to the class source file according to the return value after the chain method is called, and acquiring a comment corresponding to the field to generate a field of the interface document. The method solves the problem of repeatedly defining the meaning of the interface field so as to reduce the maintenance cost of the interface document, adopts a chain calling method, supports the characteristic of checking during compiling, finds the problem during code compiling in advance, avoids the problem caused by spelling errors, and improves the coding efficiency under the prompt of developing an auxiliary tool ide.

Description

Method for automatically obtaining comments and generating interface document according to fields

Technical Field

The invention relates to the technical field of interface document processing, in particular to a method for automatically acquiring comments according to fields to generate an interface document.

Background

In the process of developing Java, a code structured parsing technique of a Java source code file is often used to parse a Java text file into a structured data structure according to the syntactic characteristics of Java.

In an interface document, when operations such as adding, deleting, modifying and checking are carried out on a table under different scenes, the fields for modifying the table are different, and the interfaces corresponding to the different operations executed on the same table need to repeatedly define request parameters of the interface, so that the same work needs to be continuously repeated; meanwhile, when the field meaning of the table changes, all the referenced places need to be updated synchronously, which causes higher post-maintenance cost.

Disclosure of Invention

The invention aims to provide a method for automatically acquiring comments to generate an interface document according to fields, which aims to solve the problem of repeatedly defining the meaning of the interface fields so as to reduce the maintenance cost of the interface document.

In order to achieve the purpose, the invention adopts the following technical scheme:

a method for automatically obtaining comments according to fields to generate an interface document comprises the following steps:

the method comprises the following steps: adding a comment for describing a field of a class source file of Java to the field;

step two: according to fields of class source files of Java, a builder design mode is used, and according to naming rules of field names, a chain calling method which is the same as the field names is generated;

step three: calling a chain method which is the same as the field name according to the field required by the interface document to define the interface document;

step four: and acquiring a field corresponding to the class source file according to the return value after the chain method is called, and acquiring a comment corresponding to the field to generate a field of the interface document.

Preferably, in the third step, according to the fields required by the interface document, a chained method identical to the field name is called to define the interface document, including:

and on the method corresponding to each interface, using the annotated parameters to define an implementation class of the interface document, wherein the implementation class comprises a first method and a second method, the first method defines fields of interface request parameters, and the second method defines fields of interface response parameters.

A computer-readable storage medium, having stored thereon a computer program which, when executed by a processor, carries out the steps of any of the above-mentioned methods.

The beneficial effect that this application's technical scheme produced:

1. the comments of variables below class on the java source code are directly used as the comments of the fields of the interface document, so that the repeated comments of the same field are avoided, the problem of repeatedly defining the meaning of the interface field is solved, and the maintenance cost of the interface document is reduced;

2. according to the variables below class, a set of method codes which are the same as the variable names and support chain calling are automatically generated, the chain method is directly called to declare fields when an interface document is defined to check during compiling, the chain calling method supports the check during compiling, problems can be found during code compiling in advance, the problems caused by misspelling are avoided, and meanwhile, the chain calling method improves the coding efficiency under the prompt of developing auxiliary tools.

Drawings

FIG. 1 is a flow diagram of a method for automatically generating an interface document from field captured annotations, in accordance with an embodiment of the present invention.

Detailed Description

The technical scheme of the invention is further explained by the specific implementation mode in combination with the attached drawings.

In an interface document, when operations such as adding, deleting, modifying and checking are carried out on a table under different scenes, the fields for modifying the table are different, and the interfaces corresponding to the different operations executed on the same table need to repeatedly define request parameters of the interface, so that the same work needs to be continuously repeated; meanwhile, when the field meaning of the table changes, all the referenced places need to be updated synchronously, which causes higher post-maintenance cost. And since the field definitions of the interface document can only be plain string text, compile-time checks cannot be made. In order to solve the above problem, the present application proposes a method for automatically generating an interface document according to a field obtained comment, as shown in fig. 1, including the following steps:

the method comprises the following steps: adding a comment for describing a field of a class source file of Java to the field;

step two: according to fields of class source files of Java, a builder design mode is used, and according to naming rules of field names, a chain calling method which is the same as the field names is generated;

step three: calling a chain method which is the same as the field name according to the field required by the interface document to define the interface document;

step four: and acquiring a field corresponding to the class source file according to the return value after the chain method is called, and acquiring a comment corresponding to the field to generate a field of the interface document.

Preferably, in the third step, according to the fields required by the interface document, a chained method identical to the field name is called to define the interface document, including:

and on the method corresponding to each interface, using the annotated parameters to define an implementation class of the interface document, wherein the implementation class comprises a first method and a second method, the first method defines fields of interface request parameters, and the second method defines fields of interface response parameters.

In this embodiment, for example, an Order table Order corresponds to a code entity ordererity, and 3 columns are arranged on the surface of the Order table and respectively correspond to 3 fields of the code entity ordererity: price, quantity, and amount. There are two interfaces, and the functions implemented by the two interfaces are respectively: based on the above method, when defining the documents of the interface a and the interface B, only the implementation classes of the two documents of the interface a and the interface B need to be implemented, the field names of the parameters are collected in the method for defining the request parameters, and then the comments beginning with "/" above the corresponding field in the code entity orderenty and ending with "/" are resolved according to the field names to be used as descriptions of the fields in the interface document.

In this embodiment, the process of collecting the field names of the parameters is the process of calling the chain methods corresponding to the fields with the same name, each chain method is called, the field names corresponding to the corresponding entities are returned in the form of character strings, and a set of field names, that is, all the fields required by the interface, is formed by calling a series of chain methods.

Further, a chain method defines a field of an interface document, and may be understood as a method having the same name as the field, for example, as for the above-mentioned example, three methods may be defined, namely, the names of the method is print (), quality (), and amount (), and then each method returns a corresponding character string: "print", "qualification" and "around", the calling method using the chain method name is to use the verification mechanism of the compiler to check the spelling problem of the method when defining the field many times, improve the correctness, and at the same time, improve the writing efficiency of the code in the auxiliary input support of the development tool ide. The character string is returned because text characters are needed to be associated with the field names of the entities, corresponding fields are found, and then comments above the fields acquired after the java source file is analyzed are found to be used as field descriptions of the interface document.

A computer-readable storage medium, having stored thereon a computer program which, when executed by a processor, carries out the steps of any of the above-mentioned methods.

The technical principle of the present invention is described above in connection with specific embodiments. The description is made for the purpose of illustrating the principles of the invention and should not be construed in any way as limiting the scope of the invention. Based on the explanations herein, those skilled in the art will be able to conceive of other embodiments of the present invention without inventive effort, which would fall within the scope of the present invention.

Claims (3)

1. A method for automatically obtaining comments and generating interface documents according to fields is characterized by comprising the following steps:

the method comprises the following steps: adding a comment for describing a field of a class source file of Java to the field;

step two: according to fields of class source files of Java, a builder design mode is used, and according to naming rules of field names, a chain calling method which is the same as the field names is generated;

step three: calling a chain method which is the same as the field name according to the field required by the interface document to define the interface document;

step four: and acquiring a field corresponding to the class source file according to the return value after the chain method is called, and acquiring a comment corresponding to the field to generate a field of the interface document.

2. The method for automatically generating an interface document according to the comment obtained by the field as claimed in claim 1, wherein:

in the third step, according to the fields required by the interface document, a chained method identical to the field name is called to define the interface document, which includes:

and on the method corresponding to each interface, using the annotated parameters to define an implementation class of the interface document, wherein the implementation class comprises a first method and a second method, the first method defines fields of interface request parameters, and the second method defines fields of interface response parameters.

3. A computer-readable storage medium storing a computer program, the computer program characterized in that:

the computer program when being executed by a processor realizes the steps of the method as set forth in any of the claims 1-2.

Images