JPH05324289A - Device for automatically generating programming specification - Google Patents

Abstract

PURPOSE:To automatically generate a programming specification out of the same program based on the comment description in the inherent system described in the source program and to arrange it by dividing into logical structure units to be kept within the specified paper size. CONSTITUTION:When an operation start is instructed for a control section 11, the source program with the comment description inherent to the device is inputted from a source program analysis/programming specification automatic generation section 3. Accordingly, the flow of program, the program control structure, and the comment description inherent to the device are analyzed to generate meta-data being the basic data of the programming specification to be stored in a file 4. Then a programming specification automatic division section 5 is started, and when the programming specification shown by the metal-data in the file 4 is an example of algorithm chart, it is divided in logical nesting level units by recognizing the control structure to be arranged in the specified paper size.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a software development support device, and more particularly to a program design document automatic creation device for automatically generating design information that can be extracted from a source program as a maintenance program design document.

[0002]

2. Description of the Related Art Generally, a program is created by the following procedure. First, a module design document and a program design document represented by a flowchart are created (program design process), and based on this, a source program for actually operating the program on a computer is created (program manufacturing process). Next, the created program is inspected by operating it on an actual computer for checking whether there is any error (program inspection step). If there is an error in the created program, the source program is modified (program modification process).

At this time, if there is an error in the created source program, the corresponding program design document must be corrected at the same time as the source program. At this time, it is necessary to judge whether or not the source program is modified, search for a modified portion of the program design document corresponding to the modified location of the source program, and modify the actual program design document.

Conventionally, a series of processes for modifying the above-mentioned program design document accompanying the modification of the source program, that is, the presence or absence of modification of the source program generated in the program inspection process, the program design document corresponding to the location of modification of the source program Retrieval of the correction part of and the correction of the actual program design document were performed manually by the operator (designer), which was complicated.

Further, since a series of processes for modifying the program design document are manually performed, it is difficult to accurately reflect the modification of the source program in the program design document, that is, the program design document is erroneous. It is easy to cause inconsistency between the program design document and the source program,
(1) Does not function well as a maintenance program design document,
(2) There has been a problem that it takes a huge amount of time to recognize the corrected portion and to perform the correction work.

[0006]

As described above, conventionally, a series of processes for modifying the program design document accompanying the modification of the source program must all be performed manually by the operator, and therefore the source code must be modified. Revision of the program cannot be accurately reflected in the program design document, and it does not function sufficiently as a maintenance program design document.
There was a problem that a huge amount of time was required for modification work, which was a major obstacle in software development and maintenance.

The present invention has been made in view of the above circumstances, and an object thereof is to simply write a comment in a unique format in a source program and use the comment description to generate a program design document from the source program. It is to provide a program design document automatic creation device that can automatically create.

Another object of the present invention is to provide a program design document automatic creating apparatus capable of dividing and arranging the generated program design document into logically meaningful units so that the program design document can fit into a designated paper size. To do.

[0009]

According to the present invention, there is provided a source program file in which a source program having a comment description portion described in a unique comment description format without a description set in a program design document is stored, Input the source program from this source program file, analyze the program flow, the program control structure and the comment description part of the unique comment description format, and design based on the analysis result, including the above description from the program. And a program design document generating means for extracting information and generating a program design document.

According to the present invention, the program design document generated by the program design document generating means has a logical structure, for example, a logical nesting level (nesting level) of a control structure so that the program design document can be contained in a designated paper size. It is characterized by further comprising a dividing means for dividing and arranging into units.

[0011]

In the above configuration, when it is necessary to create a program design document represented by an algorithm chart, the user, when creating a source program, an explanation or the like to describe on the program design document. In accordance with a unique comment description format (comment description format peculiar to the device of the present invention). When the source program having such a comment description part is stored in the source program file and the operation start of the device is instructed by specifying the paper size of the program design document, the program design document generating means is activated. To be done.

Then, the program design document generating means inputs the source program from the source program file, analyzes the program flow, the program control structure, and the comment description part of the unique format, and based on the analysis result, the program. The design information including the above description is extracted from to generate a program design document.

Here, three types of first, second, and third types are prepared as the unique comment description formats. In this case, the program design document generating means has a comment description portion of the first type (comment description format) in the source program, and a comment of a unique format that appears next from the comment description portion in the program. If a control structure statement exists up to the description part, the program design document data that has at least a symbol corresponding to each control structure statement and the comment description content is set at the head symbol is generated, and the control structure statement is generated. If is not present, the program design document data in which the comment description content is set in the predetermined symbol is generated.

Further, the program design document generating means, if the second type comment description portion exists in the source program, from the comment description portion in the same program to the comment description portion of the unique format that appears next. All existing control structure statements are ignored, and program design document data in which comment description contents are set in predetermined symbols is generated. Further, the program design document generating means, if the third type comment description part exists in the source program, a program that abstractly expresses from the comment description part in the same program to the comment description part of the same type that appears next. Generate design document data.

When the program design document generating means (data thereof) is generated, the dividing means is activated. When the program design document does not fit in the designated paper size, the dividing means divides the program design document in units of logical structures and arranges the program design document so that it fits in the designated paper size. For this division / arrangement, for example, if the program design document is an algorithm chart, in the case of division that can be considered in logical nesting level units of the control structure, search for the division that has the smallest number of divisions that fits in the specified paper size. Done.

According to the above configuration, the user, when creating the source program, describes the description or the like to be described in the program design document in the corresponding portion of the source program according to the unique comment description format. If you leave
By simply operating the device of the present invention, a program design document corresponding to the source program can be automatically created, and further, it can be automatically divided / arranged into a designated paper size.

[0017]

DESCRIPTION OF THE PREFERRED EMBODIMENTS FIG. 1 is a block diagram showing the configuration of an automatic program design document creating apparatus according to an embodiment of the present invention.

In FIG. 1, reference numeral 1 is a source program file in which a source program which is a source of a program design document is stored. In the source program stored in this file 1, a comment peculiar to the apparatus of this embodiment is described. Reference numeral 2 indicates a part of the source program (source program portion), and reference numerals 21 to 23 indicate (specific examples) of comments peculiar to the apparatus of this embodiment which are actually described in the source program portion 2.

Reference numeral 3 denotes a source program analysis / analysis that analyzes the flow of the source program stored in the source program file 1, the program control structure, and the comment description peculiar to this apparatus, and generates the meta data of the program design document.
The program design document automatic generation unit 4 is a file (meta data file) in which the meta data generated by the source program analysis / program design document automatic generation unit 3 is stored. The meta data means the type of source program (C language, FORTRAN, etc.), the type of program design document (flowchart, etc.), an algorithm chart that is an internal specification seen as a white box, and an external seen as a black box. It does not depend on specifications such as module specifications,
This is the basic data of the program design document.

Reference numeral 5 is a program design document automatic dividing section for automatically dividing and arranging the program design document indicated by the meta data stored in the meta data file 4 so as to fit into a designated paper size, and 6 is a program A program design document file in which (the data of) the program design document divided and arranged by the automatic design document dividing unit 5 is stored, and 7 is a program design for displaying, editing, and printing the program design document stored in the file 6. It is a book display / editing / printing section. A set of the program design document automatic dividing unit 5 and the program design document displaying / editing / printing unit 7 is prepared for each type of program design document, but only one set is shown in FIG. Reference numeral 8 is a display device used for displaying the program design document, and 9 is a printing device used for printing the program design document.

Reference numeral 10 denotes an operation start instruction to the apparatus, the type of program design document, and the size of the design sheet (A4, A3,
An input device for inputting other arbitrary paper sizes, etc. by a user operation, 11 is a source program analysis / program design document automatic generation unit 3, a program design document in response to an input of an operation start instruction or the like from the input device 10. Automatic division unit 5
Also, the control unit controls the program design document display / editing / printing unit 7 to automatically create the program design document.
The source program analysis / program design document automatic generation unit 3, program design document automatic division unit 5, program design document display / editing / printing unit 7, and control unit 11 are programs stored in a storage device of an information processing apparatus. It is a functional block realized by a dedicated program for automatically creating a design document and a CPU (not shown) that executes the program.

Next, an outline of the processing of the program design document automatic creation apparatus shown in FIG. 1 will be described. First, a user who intends to automatically create a program design document using this device, when creating a source program, an explanatory note (hereinafter referred to as symbol description information) that he / she wants to describe on the program design document.
Is described in accordance with the comment description method peculiar to the present apparatus, as indicated by reference numerals 21 to 23 in FIG.

Next, the user operates the input device 10 while the source program in which the comment description peculiar to this device is written is stored in the source program file 1,
Enter the type of program design document you want to create, the size of the paper, and the operation start instruction. According to the user's input operation, the input device 10 instructs the control unit 11 to specify the type of program design document and the paper size, and further instruct to start the operation.

Upon receiving an operation start instruction from the input device 10, the control unit 11 first activates the source program analysis / program design document automatic generation unit 3. As a result, automatic creation of the program design document described below is started.

The source program analysis / program design document automatic generation unit 3 inputs the source program stored in the source program file 1, analyzes the flow of the program, the control structure of the program, and the comment description peculiar to this apparatus, Meta, which is the basic data of the program design document
Data is generated and stored in the meta data file 4.
Source program analysis / program design document automatic generation unit 3
When the meta data generation is completed, the control unit 1
Notify 1. As a result, the control unit 11 activates the program design document automatic dividing unit 5.

The program design document automatic dividing section 5 first arranges the program design document indicated by the meta data stored in the meta data file 4 in a logical virtual infinite space. Next, the program design document automatic dividing section 5 checks whether or not the program design document in the virtual infinite space fits in the designated paper size, and if it does not fit, the program design document is designated as the designated program design document type, the paper size. Automatically split based on size. Here, for example, if it is a module specification, division (by line) is performed due to overflow of lines, and if it is an algorithm chart, it recognizes the control structure (logical nesting level depth), Among the possible cases of division in logical nesting level units, the most efficient (less division) division that fits the specified paper size is searched for.

The program design document for which automatic division is completed in this way is stored in the program design document file 6 as a program design document automatically generated by this apparatus.
This program design document is under the control of the control unit 11.
The program design document display / editing / printing unit 7 displays and outputs from the display device 8 and prints out from the printing device 9.

If the result of the arrangement / division of the displayed or printed program design document is unintended,
That is, when there is a problem in the automatic division result, or when it is necessary to change it again, while observing the arrangement / division result of the program design document displayed on the display device 8, the re-editing (correction) location is performed using the input device Is specified, and the operation for re-editing (correcting) the program design document is performed. Then, the program design document display / editing / printing unit 7 operates under the control of the control unit 11 to re-edit the portion of the program design document stored in the file 6 designated on the display device 8. Is done.

Next, the details of the processing of the source program analysis / program design document automatic generation unit 3 will be described with reference to FIG. 2 when the designated program design document is an algorithm chart.
And it demonstrates with reference to the flowchart of FIG.

First, the processing of the source program analysis / program design document automatic generation unit 3 includes the structural statements of sequential processing (sequential processing structural statements) constituting the source program stored in the source program file 1 and the selection and iterative processing. From each control structure statement and the comment description peculiar to this device, extract the comment description content (symbol description information) that is the explanation structure on the algorithm control structure and program design document,
It is based on that information. The control structure statement of the source program is a while statement, if statement, or the like that indicates repetition of program processing or a branch.

When the source program analysis / program design document automatic generation unit 3 is activated by the control unit 11, only one line of the source program is input from the source program file 1 for lexical interpretation and comment description portion. Is checked (steps S1 and S2 in FIG. 2).
Taking a C language source program as an example, the comment is described in the source program in the format defined by / * * /.

If it is a comment description, the source program analysis / program design document automatic generation section 3 checks whether or not the description is a comment peculiar to this apparatus (step S3 in FIG. 2). The comment description format unique to this device is C
Taking a language as an example, the following three types a to c are prepared. (1) Type a comment description / * [] * / (2) Type b comment description / **** / (3) Type c comment description / * <> * /

The symbol description information is of type a between "/ * [" and "] * /" and type b between "/ **" and "** /". If c then "/
It is described between * <”and“> * / ”, respectively.

The comment description of the type a is searched for all control structure statements existing from the comment description to the comment description specific to the apparatus that appears next, and if there is a control structure statement, at least the control structure statement is searched. This is for generating meta data in which a symbol corresponding to each sentence is generated and comment description contents (symbol description information) are set in the leading symbol. Such a meta data generation mode is referred to as a total control structure statement analysis mode. In the case of a sequential processing structure statement in which a control structure statement does not exist, the symbol description information is set to the symbol from that comment description to immediately before the comment description unique to the present apparatus that appears next. Meta data is generated.

Next, in the type b comment description, all control structure statements existing from the comment description to the comment description specific to the present apparatus appearing next are ignored, and symbol description information is set to one symbol. It is for generating the meta data. Such a meta data generation mode is called an incidental control structure statement ignore mode.

Next, the comment description of the type c is for designating an abstract expression when an arbitrary process is to be expressed abstractly on the program design document. From the comment description The meta data that abstractly expresses up to the next comment description of the same type (however, it does not have symbol description information) is generated. Such a meta data generation mode is called an abstract representation mode.

Here, the comment description of type a (/ *
Source program analysis / program design document automatic generation unit 3 for source program parts having [] * /)
In addition to the operations of the flowcharts of FIGS. 2 and 3,
This will be described with reference to FIG. Note that FIG. 4 shows a specific example of the program design document (flow chart) indicated by (a part of) the source program having the type-a comment description and corresponding meta data. A representative example of the control structure statement of the iterative processing is shown in FIG. 7B, and a control structure statement of the selection processing is shown in FIG.

If the source program analysis / program design document automatic generation unit 3 determines in step S3 in FIG. 2 that the comment description is peculiar to the present apparatus, which of the types a to c is the comment description? (In the case of type c, it is checked whether or not it is a comment description with symbol description information) (step S4 in FIG. 2).

If the comment description is of type a,
Source program analysis / program design document automatic generation unit 3
Sets all control structure sentence analysis mode and extracts the symbol description information which is the comment description content thereof (step S5 in FIG. 2). Then, the source program analysis / program design document automatic generation unit 3 performs the processing in the all-control-structure-statement analysis mode whose details are shown in FIG. 3A (step S in FIG. 2).
6).

In the processing of this full control structure statement analysis mode,
First, the subsequent one line of the source program is input and lexical analysis is performed (FIG. 3A, step S61). if,
If the line is a control structure statement, meta data in which the symbol description information extracted in step S5 in FIG. 2 is set for one symbol (for example, a diamond symbol) is generated (step S62 in FIG. 3A). 63). On the other hand, if the line is not a control structure statement, meta data in which the symbol description information extracted in step S5 of FIG. 2 is set for one symbol (for example, box symbol) is generated (FIG. 3A). Steps S62, 64).

When step S63 or S64 is executed, the subsequent line of the source program is input and lexical analysis is performed (FIG. 3 (a) step S65). If the line is not a comment description or control structure statement peculiar to the present apparatus (step S66 of FIG. 3A), the process returns to step S65 and the lexical analysis of the next one line is performed. That is,
The source program is skipped until a comment description or control structure statement specific to this device is detected. And
When the comment description or control structure statement peculiar to this device is detected, the process of all control structure statement analysis mode (step S in FIG. 2).
6) ends.

Therefore, according to the processing in the all control structure statement analysis mode, as shown in FIG.
In the structure of sequential processing in which the (le, if keywords) do not exist, the comment description of type a to the comment description that appears next (just before) is, for example, one box symbol as indicated by reference numeral 41 in FIG. 4A. And symbol description information is set to the symbol.

Similarly, as shown in FIG. 4B, when there is a control structure statement having the keyword "while" next to the comment description of type a, reference numeral 42 in FIG. The symbol description information is set to the symbol indicating the repeating structure of the program design document as shown. Further, as shown in FIG. 4C, when a control structure statement having a keyword “if” exists after the comment description of type a, a program as indicated by reference numeral 43 in FIG. Symbol description information is set in the symbol indicating the selection structure of the design document.

When the processing of all control structure sentence analysis mode (step S6 in FIG. 2) is completed, if the processing for all sources is not completed (step S12 in FIG. 2), the process returns to step S2 in FIG. In step S2, as described above, it is checked whether or not it is a comment description, and if it is a comment description, the process corresponding to the type of the comment description is performed.

On the other hand, if it is not a comment description, the subsequent source program is input and lexical analysis is performed until the next comment description appears, and the meta data corresponding to the control structure statement that appears during that time is generated ( Figure 2 Step S
13).

Next, the case where it is detected in step S4 that the comment description is of type b will be described. In this case, the source program analysis / program design document automatic generation unit 3 sets the incidental control structure statement ignore mode,
Moreover, the symbol description information which is the comment description content is extracted (step S7 in FIG. 2). The source program analysis / program design document automatic generation unit 3 is shown in FIG.
The process of the incidental control structure statement ignoring mode whose details are shown in FIG.

In the processing of the incidental control structure statement ignoring mode, first, one line of the subsequent source program is input and lexical analysis is performed (FIG. 3 (b) step S81). When the comment description peculiar to this apparatus is detected, the meta data in which the symbol description information extracted in step S7 in FIG. 2 is set in one symbol (for example, box symbol) is generated (FIG. 3 (b)). (Step S83), the process of the incidental control structure statement ignore mode (step S8 in FIG. 2) ends.

As described above, in the incidental control structure statement ignoring mode, all the control structure statements existing from the comment description of type b to the comment description specific to this apparatus that appears next are ignored and one symbol (box symbol) becomes a symbol. Meta data in which descriptive information is set is generated.

By the way, reference numeral 52 is attached to the essential processing of the program as shown by reference numeral 51 in FIG.
The processing indicated by (the incidental processing for essential processing), etc.
Even with this control structure, there are cases where you do not want to express it as a program design document. However, in the comment description of type a, these incidental processes are also represented by the symbol corresponding to the control structure statement as indicated by reference numeral 53 in FIG. 5A by the process of step S13 of FIG.

On the other hand, by using the above type b comment description, as shown in FIG. 5B, the incidental processing existing from the type b comment description to the comment description peculiar to this apparatus that appears next. Can be prevented from being expressed in the program design document.

Now, when the processing of the incidental control structure statement ignoring mode (step S8 in FIG. 2) is completed, if the processing for all the sources is not completed (step S1 in FIG. 2).
2) and returns to step S2 in FIG. In step S2, as described above, it is checked whether or not it is a comment description. If step S8 is exited, it is a comment description, and in this case, the processing corresponding to the type of the comment description is performed.

Next, the case where it is detected in step S4 that the comment description is of type c with symbol description information will be described. In this case, the source program analysis / program design document automatic generation unit 3 sets the first abstraction expression mode and extracts the symbol description information which is the comment description content thereof (step S9 in FIG. 2). Then, the source program analysis / program design document automatic generation unit 3 performs the processing in the first abstraction expression mode whose details are shown in FIG. 3C (step S10 in FIG. 2).

In the processing of this first abstract representation mode,
First, the symbol description information extracted in step S9 in FIG. 2 is 1
The meta data set to one symbol (for example, a box symbol) is generated, followed by (the start of) an abstract representation
(In this case, specific meta data "refinement" indicating the details of the target part of the abstract expression) is generated (steps S101 and 102 in FIG. 3C).

Next, one line of the subsequent source program is input and lexical analysis is performed (step S10 in FIG. 3 (c)).
3). If the line is neither a comment description nor a control structure statement peculiar to this apparatus (step S10 in FIG. 3C).
4) Then, returning to step S103, the lexical analysis of the next one line is performed. That is, the source program is skipped until the comment description or control structure statement peculiar to this apparatus is detected.

When the comment description or control structure statement peculiar to this apparatus is detected, the processing in the first abstract representation mode (step S10 in FIG. 2) is completed, and the processing for all the sources must be completed. If (Fig. 2 Step S1
2) and returns to step S2 in FIG. In this step S2, it is checked as described above whether or not it is a comment description. If it is a comment description, the process corresponding to the type of the comment description is proceeded to. If it is not a comment description, the step S13 in FIG. Go to processing.

When a comment description of type c without the symbol description information is detected, processing of the second abstract representation mode whose details are shown in FIG. 3D is performed (FIG. 2).
Step S11). In the processing of the second abstract representation mode, first, meta data representing (the end of) the abstract representation (here, a specification called "end refinement" indicating the end of the details of the target part of the abstract representation is specified). Meta data) is generated (step S111 in FIG. 3D). Next, one line of the subsequent source program is input and lexical analysis is performed (step S11 in FIG. 3D).
2). If the line is neither a comment description peculiar to the apparatus nor a control structure statement (step S11 in FIG. 3D).
3) Then, returning to step S112, the lexical analysis of the next one line is performed. That is, the source program is skipped until the comment description or control structure statement peculiar to this apparatus is detected.

When the comment description or control structure statement peculiar to the present apparatus is detected, the processing in the second abstract representation mode (step S11 in FIG. 2) ends, and the processing for all the sources must end. If (Fig. 2 Step S1
2) and returns to step S2 in FIG.

According to the above-described processing of the first and second abstract representation modes, from the comment description of type c with symbol description information shown by reference numeral 61 in FIG.
The process up to the comment description of the type c without the symbol description information indicated by is represented in abstract by the symbol description information as indicated by reference numeral 63 or reference numeral 64 in FIG.

The comment description peculiar to the present apparatus, that is, the comment description of the types a to c is added to the comment description "/ * * /" (example of C language) of a normal source program with "[" and "". ] ”(For type a),
Since the structure has "*" and "*" (for type b) and "<" and ">" (for type c) added, it has no effect on the compiler, As described above, the meaning of “explanatory note described in symbol” is given only to this apparatus. As described above, the comment description peculiar to the present device has a function of controlling not only the comment description to the symbol but also the correspondence between the source program and the program design document when the program design document is generated.

As described above, the meta data which is the basic data of the program design document such as the algorithm chart generated by the source program analysis / program design document automatic generation section 3 is stored in the meta data file 4. As described above, the meta data is a data format that does not depend on the type of source program and the type of program design document.

FIG. 7 is for explaining the meta data format, and 71 shows an example of the meta data. This meta data 71 is a repeat control statement (whi) of C language 72.
le sentence) 73, FORTRA corresponding to this control sentence 73
A control statement (DO statement) 75 in N language 74, etc., is described in a comment peculiar to the apparatus (/ * [] * in the example of C language 72).
/, CC in the example of the FORTRAN language 74) is also synthesized, and the symbol “1.
A common data format such as p ″. Further, an example of the meta data in the case of FIGS. 5A, 5B and 6 is shown below. (1) FIG. In the case of 1.) [Process 1]; 2. [Process 2]; 3. if [] then 4.5. [] End if; 5. []; 6. [Process 3]; (2) In the case of FIG. 5 (b) 1. [Process 1]; 2. [Process 2]; 3. [Process 3]; (3) In the case of FIG. 1. [Process 1]; Part 2]; refinement 3. [Processing 3]; 4. [Processing 4]; end refinement; 5. [Processing 5];

The above is the case where the program design document is an algorithm chart, but the apparatus of FIG. 1 can also automatically generate a form-specific module specification document. Therefore, in this embodiment, in the comment part called the header of the source program, as shown in FIG. 8, the module header 81, which is a dedicated header part for module specifications, is used.
Is provided, a certain rule (keyword) is given to the comment description format of the header 81, and the module specification (MS
It corresponds to the (pec sheet) 82. By this association, the source program analysis / program design document automatic generation unit 3 can generate the module specifications (M-Spec sheet) 82 from the module header 81 of the source program.

Next, with reference to the flowchart of FIG. 9 and the automatic division explanatory diagram of FIG. 10, the details of the processing of the program design specification automatic dividing unit 5 will be described, taking the case where the designated program design specification is an algorithm chart as an example. explain.

First, the program design document automatic dividing unit 5 inputs meta data from the meta data file 4, arranges the algorithm chart indicated by the meta data in a logical virtual infinite space in the form of a flow chart, The chart is to be divided (step S91 in FIG. 9). At the same time, the program design document automatic dividing unit 5 attaches a level (the shallowest level is level 1) to the nesting depth of the control structure symbols in the flowchart. An example of a flowchart arranged in this virtual infinite space and given with nesting depth levels is shown in FIG.

Next, the program design document automatic dividing section 5 checks whether or not the target sheet (first, one sheet arranged in the virtual infinite space) fits within the designated sheet size (step S92 in FIG. 9). If it does not fit, the "nesting depth level to be divided" is set to the maximum value of the nesting depth level of the algorithm chart arranged in the virtual infinite space (step S93 in FIG. 9). As a result, FIG.
In the example of (a), the “depth level of nesting to be divided” is initially set to “4”.

Next, the program design document automatic dividing unit 5 finds the control structure symbol of the "depth level of nesting to be divided"("4") set in step S93 from the algorithm chart arranged in the virtual infinite space. Split (Fig. 9)
Step S94). Then, the program design document automatic dividing unit 5 checks whether or not the algorithm chart arranged in the virtual infinite space after division fits within the designated paper size (step S95 in FIG. 9). Is once cancelled, and the "depth level of nesting to be divided" is made one level shallower (step S96 in FIG. 9).

The program design document automatic dividing unit 5 reduces the "depth level of nesting to be divided" by one level (here, from "4" to "3"), and the above step S9 is performed.
4 division processing and step S based on the division processing result
Check 95. In this way, the program design document automatic dividing unit 5 until the algorithm chart arranged in the virtual infinite space after division fits into the designated paper size,
Steps S96, S94 and S95 are repeated.

Eventually, as shown in FIG. 10 (b), as a result of division by the control structure symbol of "nesting depth level to be divided""2", the algorithm chart arranged in the virtual infinite space after division is designated. When it fits into the paper size, the program design document automatic dividing unit 5 sets the divided level algorithm portion, that is, the control structure symbol portion (here, the level 2 control structure symbol portion) as a new division target. (Step S97 in FIG. 9).

Next, the program design document automatic dividing section 5 returns to the above step S12, and the algorithm chart portion to be divided (the control structure symbol portion of level 2).
Check whether the paper size fits in the specified paper size, and
If it fits as shown in (b), a series of automatic division processing ends. The program design document for which automatic division has been completed in this way is stored in the program design document file 6 as a program design document automatically generated by this apparatus.
On the other hand, if the algorithm chart portion to be divided does not fit within the specified paper size, step S93
Then, a new division process for this algorithm chart portion is started.

Thus, the program design document automatic dividing unit 5
Is characterized by applying a new method of dividing a portion where the algorithm chart physically exceeds the paper size unconditionally, instead of dividing by a logical nesting level of the control structure.

[0071]

As described in detail above, according to the present invention,
If a comment in a unique description format that forms the explanatory text to be set in the program design document is described in the source program, the flow of the program, the program control structure, and the comment description part in the unique format are described from the source program. A program design document is created automatically by analyzing the design information and extracting design information including explanations from the program based on the analysis result to generate the program design document. It is possible to save a lot of labor.

Further, according to the present invention, since the program design document that always matches the source program is automatically created, it is possible to eliminate variations in quality among creators.

Further, according to the present invention, the generated program design document is divided into units of logical structure, in particular, the logical nesting level of the control structure so as to fit in the designated paper size. The divided portions can be logically meaningful as compared with the method of unconditionally dividing the portion that physically exceeds the paper size.

[Brief description of drawings]

FIG. 1 is a block diagram showing the configuration of a program design document automatic creation apparatus according to an embodiment of the present invention.

FIG. 2 is a flowchart showing a processing procedure of a source program analysis / program design document automatic generation unit 3 in FIG.

FIG. 3 shows steps S6 and S in the flowchart of FIG.
The figure which shows the detail of the process of 8, S10, and S11.

FIG. 4 is a diagram showing a specific example of a program design document (flow chart) indicated by meta data corresponding to (a part of) a source program having a comment description of type a.

FIG. 5 compares a specific example of a program design document (flowchart) indicated by meta data corresponding to (a part of) a source program having a comment description of type b with an example of a source program having a comment description of type a. The figure shown.

FIG. 6 is a diagram showing a specific example of a program design document (flow chart) indicated by meta data corresponding to (a part of) a source program having a comment description of type c.

FIG. 7 is a diagram for explaining a meta data format.

FIG. 8 is a diagram showing a comment description format of a module header provided in a source program in comparison with a module specification.

9 is a flowchart showing a processing procedure of a program design document automatic dividing unit 5 in FIG. 1. FIG.

10 is a diagram for explaining automatic division of a program design document (flow chart) by the program design document automatic dividing unit 5 in FIG. 1;

[Explanation of symbols]

1 ... Source program file, 3 ... Source program analysis / program design document automatic generation unit, 4 ... Meta data file, 5 ... Program design document automatic division unit, 6 ... Program design document file, 7 ... Program design document display / edit -Printing unit, 8 ... Display device, 9 ... Printing device, 10 ... Input device, 11 ... Control unit, 21-23 ... Comments.

Claims (6)

[Claims] 1. A source program file in which a source program having a comment description part described in a unique comment description format without a description set in a program design document is stored, and a source program file stored in the source program file. Input the source program, analyze the program flow, the program control structure and the comment description part of the unique comment description format, and extract the design information including the description from the program based on the analysis result. An apparatus for automatically creating a program design document, comprising: a program design document generating means for generating a program design document by means of: 2. The first comment description format as the unique comment description format
Of the first type in the source program, the program design document generating means defines
If there is a comment description part of the comment description format of the type and there is a control structure statement from the comment description part in the source program to the comment description part of the unique comment description format that appears next, Each has a symbol corresponding to each control structure statement, and generates the program design document data in which the comment description content is set in the first symbol, and if the control structure statement does not exist, the comment description content in the predetermined symbol The program design document automatic creation apparatus according to claim 1, wherein the program design document data in which is set is generated. 3. The second comment description format as the unique comment description format
Of the comment description format of the type
When there is a comment description part of the comment description format of the above type, all control structure statements existing from the comment description part in the source program to the comment description part of the unique comment description format that appears next are ignored. ,
The program design document data in which the comment description content is set in a predetermined symbol is generated.
Automatic program design document creation device. 4. The third comment description format is unique to the unique comment description format.
Of the third type is defined, and the program design document generating means defines the third
When a comment description part of the comment description format of the type exists, the program design document data that is an abstract representation from the comment description part in the source program to the comment description part of the same type that appears next is generated. 4. The program design document automatic creation apparatus according to claim 3. 5. A dividing unit is further provided for dividing and arranging the program design document generated by the program design document generation unit in units of a logical structure so that the program design document fits within a designated paper size. 5. The program design document automatic creation device according to claim 1, wherein: 6. The program designing program according to claim 5, wherein the dividing unit divides the program designing document in units of logical nesting levels of the control structure when the program designing document is an algorithm chart. Automatic call creation device.