JPH07129381A - Program document creation device - Google Patents

Abstract

(57) [Summary] [Purpose] To always obtain high-quality documents. [Structure] A program input from a program file storage device 6 is analyzed by a document data generation device 2 and decomposed into respective elements, and a user sets the content of a template of document data generated based on the result of this analysis on a terminal device 7. The document data can be generated by using the description, and the elements of the document data are compared with the elements of the program by the comparison / combination device 4, and only the elements of the document data corresponding to the elements of all the programs are compared. By composing each other to create a document,
It is possible to always create a detailed document that describes the contents of each element of the program, and if the contents of the program are changed, create a document corresponding to the changed program so that it has a certain quality or higher. Always be able to create documents.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a program document creating apparatus, and more particularly, it is suitable for use in a program document creating apparatus for creating a document relating to operation contents and processing contents of an existing source program.

[0002]

2. Description of the Related Art Conventionally, when developing software, in order to facilitate maintenance and management of the software, a document describing the operation / processing contents of the created program is created. There is. Then, based on the already created program, a technique for creating a document representing the operation / processing content of the program has been developed.

As described above, as a system for creating a document representing the contents of an existing program, the program and the document can be described as one file in one program.
A system called an EB system is known. WE
The B system is a system that combines a programming language and a document formatting language.

FIG. 12 is an operation explanatory view showing the outline of the processing performed in the WEB system. As shown in FIG.
In this WEB system, if the data described in the WEB language is processed by a program called TANGLE, the source code of the program can be obtained. Then, the source code of the program thus obtained is applied to the compiler to generate an object.

On the other hand, data described in the WEB language is WEAV
Processing with a program called E yields the source code for the document that contains the source code for the program. Then, the source code of the document thus obtained is fine-written by the document formatter to generate the document.

As described above, in the WEB system, the WEB
An object is generated based on the portion corresponding to the program code in the data described in the language, and a document is generated based on the portion corresponding to the document code.

[0007]

However, in the WEB system as described above, the part corresponding to the program code in the data described in the WEB language and the part corresponding to the document code are very independent from each other. High, both were treated separately.

Further, since the WEB system as described above does not have a mechanism for checking the relationship between the program source and the document, the document which has nothing to do with the content of the program has been described. However, I could not detect the error.

Therefore, when the contents of the program are changed, such as when a variable or function is newly added to the program or when an existing variable or function is deleted from the program, There was a problem that the document reflecting the program change was not always obtained.

Further, since the content of the data is different for each user who describes the data in the WEB language,
The content of the document generated based on the data described in the B language varies, and there is a problem that a document having a certain quality or higher is not always obtained.

The present invention has been made in order to solve such a problem, and an object of the present invention is to provide a program document creating apparatus which can always obtain a high quality document.

[0012]

A program document creating apparatus of the present invention is a program analysis means for parsing an input program according to the grammar of its programming language, and for decomposing the program into various elements, and the program analysis means. Document data generating means for generating document data representing the contents of the program by describing the document in the template format for each element of the program decomposed by The document data analysis means for decomposing data into various elements, the element of the program decomposed by the program analysis means, and the element of document data decomposed by the document data analysis means are compared to obtain the element of the program. Check whether the corresponding document data element exists As a result of comparison by the comparing means and the comparing means, when it is determined that the elements of the document data are not insufficient for the elements of the program, the elements for which a match is detected between the two elements are combined. And a synthesizing means for generating a program document.

Another feature of the present invention is that
As a result of the comparison by the comparison means, when it is determined that the elements of the document data are insufficient with respect to the elements of the program, an error is generated.

[0014]

Since the present invention comprises the above technical means, the content of each element of the program is described in the template format by the user on the basis of the analysis result of the inputted program to generate the document data. Since the document data will be combined with the corresponding program to create a document, there will be no difference in its contents from the above programs, and detailed documents will be created that describe the contents for each element of the program. To be done.

Further, when the elements of the program and the elements of the document data are combined, the two elements are compared, and when it is determined that the elements of the document data are not insufficient for the elements of the program, a match is detected. Documents will be created by composing the created elements with each other, so if, for example, the contents of the program are changed by adding or deleting variables or functions, after the change A detailed document corresponding to the program will be created.

[0016]

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS An embodiment of the present invention will be described below with reference to the drawings. FIG. 1 is a block diagram showing a schematic configuration of a program document creation device of this embodiment. In FIG. 1, the program document creation device 1 is composed of a document data generation device 2, a document data file storage device 3, a comparison and synthesis device 4, and a structured document file storage device 5.

In the configuration of the program document creation device 1 as described above, the document data creation device 2 reads the program described in the computer language from the program file storage device 6 and analyzes the read program according to the grammar of the computer language. By doing so, a template of document data as described later is generated.

Then, the document data generation device 2 incorporates the information input from the terminal device 7 into the above-mentioned template to generate document data, and supplies the generated document data to the document data file storage device 3. The document data file storage device 3 stores the given document data as a document data file.

In the comparison / synthesis device 4, a program written in a computer language is stored in the program file storage device 6
And the document data generated as described above are input from the document data file storage device 3.

The comparison / synthesis device 4 analyzes the input program according to the grammar of the computer language, analyzes the input document data according to the grammar of the document data, compares the respective elements, and synthesizes them, which will be described later. Generate structured documents.

Then, the generated structured document is stored as a structured document file in the structured document file storage device 5 and is output to the printing device 8 such as a printer or a document clearing system.

Next, detailed configurations and operations of the document data generation device 2 and the comparison and synthesis device 4 in the program document creation device 1 described above will be described with reference to FIGS.
This will be described in detail with reference to 1. 2 is a diagram showing the configuration of the document data generation device 2, and FIG. 3 is a diagram showing the configuration of the comparison and synthesis device 4. In the following, a case will be described as an example in which a structured document for a class String relating to a character string in the C ++ language is created.

First, in the document data generating apparatus 2 shown in FIG. 2, the input unit 11 is the program file storage device 6.
Of the programs stored in, the program shown in FIG. 4, for example, is loaded. Then, the input unit 11
Supplies the program loaded from the program file storage device 6 to the program analysis unit 12.

The program analysis unit 12 analyzes the input program according to the grammatical rules of the C ++ language. That is, the program analysis unit 12 decomposes the program as shown in FIG. 4 into a plurality of elements, and names each element to obtain the analysis result of the program as shown in FIG. Then, the program analysis unit 12 supplies the analysis result thus obtained to the template generation unit 13.

Note that, in FIG. 5, the data in each row shows the elements of the program decomposed by the program analysis unit 12. Also, class String, ptr, getpt of each line
The characters r () and length () indicate the names given to the elements of the program.

Next, the template generator 13 generates a template of document data as shown in FIG. 6 based on the analysis result by the program analyzer 12. This document data template enumerates the essential items corresponding to each element of each program as described above decomposed by the program analysis unit 12.

That is, in FIG. 6, "class Strin
The required items for the g ”element are% status,% classlevel,% descri
It consists of four items indicated by ption and% history. Here, the item indicated by% status is an item indicating the design and development status of the class, such as, for example, during experiment, during debugging, or already published.

The item indicated by% classlevel is, for example, an item showing how the category of the class can be used in common, used in communication, or used in GUI. Furthermore, the item indicated by% description is an item indicating the functional description of the class, and% h
The item indicated by istory is an item indicating the creation history of the class.

On the other hand, the required items of the "ptr" element are% des
It consists of two items indicated by cription and% note.
Here, the item indicated by% note is an item indicating a caution when using the element.

The elements of "getptr ()" and "length"
The required items of () ”are% description and% retu, respectively.
It consists of three items indicated by rn and% note. Here, the item indicated by% return is an item indicating the return value of the function. Since the element of "ptr" mentioned above is a variable type element, the item of% return is unnecessary, but "getptr ()"
Since the element of and the element of “length ()” are functional elements, the item of% return is necessary.

When the input unit 11 confirms that the template data generated by the program input from the program file storage device 6 is already stored in the document data file storage device 3, the template generation unit 13 confirms. Generates a template by referring to the document data.

Then, the template generating unit 13 displays the template of the document data generated as described above on the display unit of the terminal device 7, and waits for the user to edit this template.

After that, when the user operates the keyboard of the terminal device 7 or the like to describe the contents in accordance with the display items of the template on the display unit, the document data generation unit 14 writes in the template of the document data. By incorporating the description content of each item, for example, document data as shown in FIG. 7 is generated.

Then, the document data generation unit 14 supplies the document data thus generated to the document data file storage device 3 via the output unit 15. The document data file storage device 3 stores the given document data as a document data file.

Next, in the comparison / synthesis device 4 shown in FIG. 3, the input unit 22 takes in the document data generated as described above from the document data file storage device 3, and the document data is stored in the document data analysis unit 24. Supply. Also,
The input unit 21 takes in the program shown in FIG. 4 from the program file storage device 6 and supplies the program to the program analysis unit 23.

The program analysis unit 23 analyzes the input program according to the grammatical rules of the C ++ language. In this case, the program input to the program analysis unit 23 is
The program is the same as that input to the program analysis unit 12 in FIG. 2, and the analysis result is also the same as that shown in FIG. Then, the program analysis section 23 supplies the data as shown in FIG. 5 obtained as a result of the analysis of this program to the comparison section 25.

On the other hand, the document data analysis unit 24 analyzes the input document data according to its grammar. Then, the document data analysis unit 24 supplies the data shown in FIG. 8 obtained as a result of the analysis of the document data to the comparison unit 25.

In FIG. 8, class String, ptr, g
Each data of etptr () and length () represents an element of document data. Also, class String, ptr, getptr (),
The characters of length () indicate the names of the elements of the document data.

Next, the comparison unit 25 compares the elements of the program analyzed by the program analysis unit 23 as described above,
The document data analysis unit 24 compares the elements of the document data analyzed and confirms whether or not there is an element with the same name in each. Then, the comparison unit 25 supplies a predetermined element from the input program and document data to the synthesis unit 26 according to the result of the comparison.

That is, when the names of all the elements of the program element and the element of the document data match, as in the above-described example shown in FIGS. 5 and 8, the comparison unit 25 All the elements are supplied to the synthesis unit 26.

On the other hand, when there are insufficient program elements with respect to the document data elements, the comparison unit 25
Only the elements having the same name are supplied to the synthesizing unit 26. For example, as shown in FIG. 9, when the element of “length ()” existing as the element of document data does not exist as the element of the program, the comparison unit 25 determines that the element of “length ()” of the document data. Does not supply the synthesizing unit 26, but supplies only the elements of "class String, ptr, getptr ()" having the same names to the synthesizing unit 26.

On the contrary, when the elements of the document data are insufficient for the elements of the program, there must be some elements that are present in the program but not in the document data. So I can't get the correct documentation for the program.

Therefore, in this case, the comparison unit 25
Displays an error on the display unit of the terminal device 7,
Notify the user that the document data element is missing. Then, by confirming the occurrence of such an error and regenerating the document data by the user, a correct document can always be obtained.

Next, the synthesizing section 26 synthesizes the elements of the program and the elements of the document data input from the comparing section 25 in correspondence with each other. The result of this synthesis is shown in FIG.
Furthermore, the synthesizing unit 26 adjusts the result of the synthesizing shown in FIG. 10 based on a predetermined parameter given from the terminal device 7, and supplies the data obtained as a result of this adjustment to the output unit 27.

That is, the synthesizing unit 26 can be adjusted, for example, so that an element including a private portion in the data obtained as a result of the analysis of the program by the program analyzing unit 23 is not supplied to the output unit 27. In the example of FIG. 10, the synthesis unit 26 supplies the output unit 27 with elements other than “ptr” including the private portion.

Further, the synthesizing section 26 can be adjusted so that, for example, of the data obtained as a result of the analysis of the document data by the document data analyzing section 24, the data related to note is not supplied to the output section 27. In the example of FIG. 10, the synthesizing unit 26 supplies the data of the portion excluding the note line in the element of “ptr” to the output unit 27.

Next, the output unit 27 supplies the data supplied from the synthesizing unit 26 to the structured document file storage device 5. Then, the structured document file storage device 5 stores the given data as a structured document file. In this way, a structured document is obtained in which the contents of the program are described in detail for each element, such as the attribute name, simple function description, and notes.

Further, the output unit 27 converts the data given from the above-mentioned synthesizing unit 26 into a format understandable by the printing apparatus 8 and outputs it to the printing apparatus 8. Then, the printing device 8 prints the document as shown in FIG. 11 based on the given data.

As described above, in the program document creating apparatus of this embodiment, the inputted program is analyzed according to its grammatical rules, a template of document data is generated based on the result of the analysis, and this template is used by the terminal device. Is displayed on the display. Next, the user refers to the displayed contents and describes the contents of the essential items in the template to generate the document data.

When there is a description omission of an essential item during the generation of this document data, an error is generated and the user is informed accordingly. Since the user completes the document data by adding and describing the contents of the items for which there are omissions, no matter who creates the documents, the documents of a certain quality or higher will be created without missing required items. can do.

Further, in the program document creating apparatus of the present embodiment, the user fills in the required items of the template created based on the analysis result of the input program, as described above, to create the document data. ing. Therefore, normally, there is no difference in the contents between the program and the document data.

On the other hand, when a document is created using document data that has already been generated for a certain program, variables or functions are newly added to the program, or conversely, variables or functions are deleted from the program. As a result, the contents of the program and the contents of the document data may deviate.

Therefore, in the program document creating apparatus of this embodiment, an error occurs when the elements of the document data are insufficient with respect to the elements of the program by newly adding variables and functions to the program. The user is informed of that fact and the document data is regenerated.

On the other hand, by deleting variables and functions from the program, when the elements of the program are insufficient for the elements of the document data, the elements existing only in the document data are ignored to create the document. I am trying. Therefore, it is possible to always create a document that reflects the changes in the program.

Further, in the program document creating apparatus of the present embodiment, the contents of the structured document can be adjusted by using the predetermined parameters, so that it can be adjusted according to the level of the target such as the program developer or the user. Multiple documents can be created from one program.

[0056]

As described above, according to the present invention, the document data is generated by the user describing the content of each element of the program in the template format based on the analysis result of the input program. At the same time, the elements of this document data are compared with the elements of the above program, and when it is determined that the elements of the document data are not insufficient for the elements of the program, the elements for which a match has been detected are mutually Since the document is created by synthesizing, you can always create a detailed document that describes the contents of each element of the program.
Even if the content of the target program is changed, it is possible to create a detailed document that reflects the change of the program. Therefore, no matter who creates it, you can always create documents of a certain quality or higher,
Therefore, for example, it is possible to easily search for a program component and reuse a program source and efficiently edit the program.

[Brief description of drawings]

FIG. 1 is a block diagram showing a schematic configuration of a program document creation device of the present invention.

FIG. 2 is a block diagram showing a configuration of a document data generation device.

FIG. 3 is a block diagram showing a configuration of a comparison / synthesis device.

FIG. 4 is a diagram showing an example of a program input from a program file storage device.

FIG. 5 is a diagram showing an example of analysis results of a program.

FIG. 6 is a diagram showing an example of a template of document data.

FIG. 7 is a diagram showing an example of document data.

FIG. 8 is a diagram showing an example of an analysis result of document data.

FIG. 9 is a diagram showing an example of an analysis result of a program and an analysis result of document data.

FIG. 10 is a diagram showing an example of a synthesis result of an element of a program and an element of document data.

FIG. 11 is a diagram showing an example of a structured document.

FIG. 12 is an operation explanatory view schematically showing the processing of a conventional program editing device.

[Explanation of Codes] 1 Program Document Creation Device 2 Document Data Generation Device 3 Document Data File Storage Device 4 Comparative Synthesis Device 5 Structured Document File Storage Device 6 Program File Storage Device 7 Terminal Device 8 Printing Device 11 Input Unit 12, 23 Program Analysis unit 13 Template generation unit 14 Document data generation unit 15 Output unit 21, 22 Input unit 24 Document data analysis unit 25 Comparison unit 26 Synthesis unit 27 Output unit

Claims (2)

[Claims] 1. A program analysis means for parsing an input program according to the grammar of the programming language and decomposing the program into various elements, and a template format for each element of the program decomposed by the program analysis means. Document data generating means for generating document data representing the contents of the program by describing a document, and document data analyzing means for analyzing the document data according to its grammatical rules and decomposing the document data into various elements. , Comparing the elements of the program decomposed by the program analysis means with the elements of the document data decomposed by the document data analysis means to determine whether or not the element of the document data corresponding to the element of the program exists. The comparison means to confirm and the result of the comparison by the comparison means, When it is determined that the elements of the document data are not insufficient with respect to the elements of the system, a synthesizing means for synthesizing the elements for which a match is detected between the two elements and generating a program document is provided. Characterized program document creation device. 2. The program document creating apparatus according to claim 1, wherein when it is determined that the elements of the document data are insufficient with respect to the elements of the program as a result of the comparison by the comparing means, an error is generated. A program document creating device characterized by being generated.