JPH0667872A - Commnet extracting system in source program - Google Patents

Abstract

PURPOSE:To efficiently execute operation for documentation, to prevent the generation of mistransfer and to prepare a design document with high quality by providing this comment extracting system with a means for respectively extracting and documentating comments relating to respective modules constituting a source program and comments relating to data and procedures in respective modules. CONSTITUTION:Comments relating to respective modules to be reference elements constituting the source program 110 are extracted, documentated and stored in a module comment table 107, comments relating to data in respective modules are extracted, documentated and stored in a data comment table 108 and comments relating to procedures in respective modules are extracted, documented and stored in a procedure comment table 109. Respective comments are automatically judged and documentated as a part of specifications without depending upon manual operation.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to an annotation extraction method on a source program, and more particularly to an annotation extraction method on a source program which is a reverse engineering technique of software.

[0002]

2. Description of the Related Art In the conventional annotation extraction method on a source program, in order to make the maintenance work of the existing software efficient, a human decodes the source program and uses information about the program (module information). The work of making maintenance documents (specifications related to specifications and procedures and specifications related to data) is repeated. In particular, the contents of the annotations described on the source program have important clues for deciphering the software, and based on the information of these annotations, they are documented by the following means.

A person manually transcribes a document in a paper format.

Posting into an electronic document using an editor or word processor.

Based on the control structure of the procedure on the source program, an electronic document is created by utilizing a documentation support tool having a core function of program chart generation.

A list file output by a language processor such as a compiler is used to create an electronic document.

[0007]

In the above-mentioned annotation extraction method on the source program, in the above cases 1 and 2, the annotations distributed and described on the source program are transcribed. However, there is a problem that it takes a lot of work time according to the description amount of the annotation and that the transcription must be manually performed every time the source program is changed.

Further, in the above case, the annotation described in the procedure section of the source program can be automatically documented as a simple character string by the documentation support tool, but in the data declaration section. Even if annotations are described for individual data, they are ignored by conventional documentation support tools, and the task of transcribing annotations for data by the same means as and is required to be manually performed. Since it does not have an analysis function like a language processor, it cannot extract and document specifications such as data attributes.

Further, contrary to the above case, the specifications such as data attributes can be extracted and documented as a list file, but the conventional language processor ignores the annotations. In addition, there is a problem that it is necessary to transcribe the information of the annotation by the same method as or.

[0010]

A comment extracting method on a source program according to a first invention is a module comment extracting means for extracting and documenting a comment for each module which is a basic element constituting a source program. Data annotation extracting means for extracting and documenting annotations regarding data in each module and procedure annotation extracting means for extracting and documenting annotations for procedures in each module are configured.

The annotation extraction method on the source program of the second invention is the annotation extraction method on the source program of the first invention, which is the module annotation extraction means, the data annotation extraction means, and the procedure annotation of the first invention. The output destination of the documented result by each of the extracting means is a form printing device, and the form printing device is provided for outputting the document to the form printing device.

On the other hand, the annotation extraction method on the source program of the third invention is the same as the annotation extraction method on the source program of the first invention, and is the module annotation extraction means, the data annotation extraction means, and the procedure annotation of the first invention. An output destination of a documented result by each of the extracting means is a display device such as a CRT, and display display means for displaying the document on the display device is provided.

Furthermore, the annotation extraction method on the source program of the fourth invention is the annotation extraction method on the source program of the first invention, which is the module annotation extraction means, the data annotation extraction means, and the procedure annotation of the first invention. The output destination of the documented result by each of the extracting means is the external magnetic storage device (magnetic disk device, floppy disk device,
Optical disk device, magnetic tape device, etc.) and an external magnetic storage device for storing a document in the external magnetic storage device.

[0014]

Embodiments of the present invention will now be described with reference to the drawings. FIG. 1 is a flow chart showing an embodiment of an annotation extraction method on a source program of the first invention. Also,
FIG. 2 is a diagram showing an example of a source program which is the target of the embodiment of FIG. Further, FIG. 3 is a diagram showing an example of the annotation document extracted in the embodiment of FIG.

First, as shown in the source program of FIG. 2, 101 indicates a module annotation described in the module, 102 indicates a data annotation described in the module, and 103 indicates. It shows the procedure annotations described in the module.

Further, as shown in FIG. 3, reference numeral 104 indicates that the contents of the module annotation described in the source program of FIG. 2 are generated in the explanation column of the module specification, and 105 Indicates that the content of the data annotation described in the source program of FIG. 2 has been generated in the explanation column of the data specification, and 106 indicates in the explanation column of the procedure specification of FIG. It indicates that the contents of the procedure annotation described in the source program have been generated.

As shown in FIG. 1, 110 is a saw program, 107 is a module annotation table for holding information about module annotations in the module specification, and 108 is a data specification. A data annotation table for holding information on data annotations is shown, and 109 is a procedure annotation table for holding information on procedure annotations in the procedure specification.

Reference numeral 11 denotes a sentence input from the source program, sentence by sentence, inputting a sentence for determining whether the sentence is the end and its end determination, and 12 denotes whether the sentence is inside or outside the module. 13 and 1
Reference numeral 5 indicates whether the sentence is an annotation, and reference numeral 16 indicates whether the annotation is for a data definition sentence. Reference numeral 14 indicates module annotation registration for registering module annotations in the module annotation table, 17 indicates data annotation registration for registering data annotations in the data annotation table, and 18 indicates procedure annotation registration for registering procedure annotations in the procedure annotation table. ing. The module annotation extracting means is composed of 12 and 13 and 14, the data annotation extracting means is composed of 15 and 16 and 17, and the procedure annotation extracting means is composed of 16 and 18.

FIG. 4 is a flow chart showing an embodiment of the annotation extraction method on the source program of the second to fourth inventions. As shown in FIG. 4, reference numeral 21 denotes the determination of the output destination of the document, and reference numeral 22 denotes a form printing means for outputting the document generated based on the three tables 107, 108 and 109 as the form document 201. Shown, 23 is 107 and 108 and 1
09 indicates a display display means for displaying a document generated on the basis of the three tables No. 09 and No. 09 on the display device 202. Reference numeral 24 indicates the document generated on the basis of the three tables Nos. The external magnetic storage storage means for storing in the storage device 203 is shown.

[0020]

As described above, the annotation extraction method on the source program of the present invention automatically distinguishes the annotation on the module on the source program, the annotation on the procedure in the module, and the annotation on the data in the module. Since it is documented as a part of the design document without relying on human labor, the work for documentation can be streamlined, and at the same time, there is no error such as omission of transcription or transcription error that occurs in the case of human labor, and quality is improved. This has the effect that it is possible to generate a high-quality design document.

[Brief description of drawings]

FIG. 1 is a flowchart showing an embodiment of an annotation extraction method on a source program of the first invention.

FIG. 2 is a diagram showing an example of a source program which is a target of the embodiment of FIG.

FIG. 3 is a diagram showing an example of an annotation document extracted in the embodiment of FIG.

FIG. 4 is a flow chart showing an embodiment of an annotation extraction method on a source program of the second to fourth inventions.

[Explanation of symbols]

 11 sentence input and end determination 12 module inside / outside determination 13 annotation determination 14 module annotation registration 15 annotation determination 16 data statement determination 17 data annotation registration 18 procedure annotation registration 101 module annotation 102 data annotation 103 procedure annotation 104 module specification 105 data specification 106 Procedure Specification 107 Module Annotation Table 108 Data Annotation Table 109 Procedure Annotation Table 110 Source Program 21 Document Output Destination 22 Document Printing Means 23 Display Display Means 24 External Magnetic Storage Saving Means 201 Form Format Document 202 Display Device 203 External Magnetic Storage apparatus

Claims (4)

[Claims] 1. A module annotation extracting means for extracting and documenting annotations regarding each module which is a basic element constituting a source program, and a data annotation extracting for extracting and documenting annotations regarding data in each module. An annotation extraction method on a source program, comprising: means and a procedure annotation extraction means for extracting and documenting annotations regarding procedures in each module. 2. A form printing device is used as an output destination of the results documented by each of the module annotation extracting unit, the data annotation extracting unit, and the procedure annotation extracting unit according to claim 1, and the document is output to the form printing device. The annotation extraction method on the source program according to claim 1, further comprising a printing unit. 3. The module annotation extraction means, the data annotation extraction means, and the procedure annotation extraction means according to claim 1 output a document output as a display device such as a CRT, and display the document on the display device. The annotation extraction method on the source program according to claim 1, further comprising a display display unit. 4. An external magnetic storage device (a magnetic disk device, a floppy disk device, an optical disk device) which is an output destination of a result documented by each of the module annotation extraction means, the data annotation extraction means, and the procedure annotation extraction means according to claim 1. , A magnetic tape device, etc.) and an external magnetic storage storage unit for storing a document in the external magnetic storage device.