JPH04370829A - Source code editing system - Google Patents

Abstract

PURPOSE:To offer source codes which are rich in reliability, productivity, and maintainability by inserting the text of a process flow chart as a comment of the source codes. CONSTITUTION:The process flow chart and source codes are edited at a process flow chart editing part 3 and a source code editing part 4 by using an internal memory 7 and stored in an external storage device 8. A source code comment editing part 6 stores the process flow chart and source codes stored in the external storage device, or a source code translation result in an internal memory and inserts the text in the process flow chart at its corresponding position in the source codes when the number of a key for retrieval in the process flow chart matches the number of a key for correspondence in the source codes. The result is outputted on a display terminal or printer 9.

Description

[Detailed description of the invention]

0001

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a source code editing method for automatically outputting text written in processing flow symbols into source code.

0002

2. Description of the Related Art In programming languages such as C and PL/1, comments can be written as annotations. If you use this and write the processing content for each processing step in a comment,
Helpful for understanding the program. However, in the past, sentences were input directly into source code comments using source code editing means, resulting in very poor coding efficiency.

[0003] In order to solve this problem, sentences are extracted from the products of the pre-coding process (processing flow diagrams, etc.) and
There is a way to insert it as a comment in the source code, but
As described in Japanese Unexamined Patent Publication No. 63-81528, programming language keywords (in PL/1, control keywords such as IF, WHEN, DO, etc.) are included in the processing flow diagram.
An explanatory text (text) was written in advance, and when the source code was created, the text of the keyword part was inserted into the source code as a comment.

0004

[Problem to be Solved by the Invention] In the above-mentioned conventional technology, at the stage of creating a process flow diagram, starting with keywords,
Requires considerable knowledge of programming languages. In addition, when rewriting a program by changing the programming language, such as when rewriting a program developed in PL/1 language in C language, it is necessary to rewrite the keywords in the processing flow diagram, and it is necessary to rewrite not only the source code but also the processing flow. It will also be necessary to redraw the diagrams, etc. Originally, processing flow diagrams and the like do not depend on programming languages, and it is not desirable to write keywords specific to programming languages in processing flow diagrams.

SUMMARY OF THE INVENTION In order to solve the above-mentioned problems, it is an object of the present invention to create a process flow diagram without being aware of the programming language, and to provide a source code editor that can automatically insert text in the process flow diagram into the source code. The objective is to provide source code that is easy to understand.

[0006]

[Means for Solving the Problems] An example of a system configuration required to achieve the above object is shown in FIG.

[0007] The processing flow diagram or source code input from the display terminal (1) for inputting the processing flow diagram or source code is stored in the internal memory ( 7) and stored in the external storage device (8). The source code translation unit (5) translates the source code stored in the external storage device. Source code comment editorial department (6
), the processing flow diagram, source code, or source code translation result stored in the external storage device is stored in the internal memory, and the text in the processing flow diagram is inserted into the comment in the source code or source code translation result. This result can be output to a display terminal (1) or a printer (9).

[0008]

[Operation] Processing flow diagram editing section 3, source code editing section 4
The functions of the source code comment editing section 6 are shown in Figures 2 and 3.
, will be explained using FIGS. 4 and 5.

FIG. 2 is an example of a processing flow diagram. The processing flow diagram includes flowcharts, SPD (Struct.
red Programming Diagram),
PAD (Problem Analysis Diag)
ram), but here we will explain using PAD. This example is a program that inputs numerical values and calculates the maximum value. The processing flow diagram editing unit 3 converts this PAD into PAD, which is a special language expressing the structure of PAD.
Convert to AD description language and edit. At this time, a unique number (such as TEXT001 in this case) is assigned to each PAD symbol as a search key. This number is to correspond with the corresponding key in the source code.
It does not have to be in the order of program processing.

FIG. 3 is an example of source code. Programming languages include C, COBOL, FORTRAN,
Although there are PL/1 and the like, PL/1 will be used for explanation here. PL/
1 and edit it in the source code editor. At this time, the corresponding key (here TEXT00) is inserted in the comment symbol ('/*' or '*/' in PL/1)
1st class). Since the PAD text will be inserted at this position, the comment start column position and comment end column position are determined in consideration of the position where the comment is easy to read.

FIG. 4 is an example in which the text of the PAD shown in FIG. 2 is inserted into the source code shown in FIG. P.A.
When the search key in D matches the corresponding key in the source code, the text of the PAD symbol having the matched search key is output to the comment in the source code that has the corresponding corresponding key.

FIG. 5 is an example in which parts of each of FIGS. 2, 3, and 4 are extracted and their correspondence relationships are shown. The PAD text is inserted at the position of the corresponding key (TEXT003) in the source code corresponding to the PAD search key (TEXT003).

[0013]

[Embodiment] An embodiment of the present invention will be described below with reference to FIGS. 6 and 7.

The source code and processing flow diagram are input into internal memory (601, 602). A source code translation result may be used instead of the source code.

First, input one record of the source code (
604), determine whether there is a corresponding key in the comment (
606). If there is no corresponding key, input one more record of the source code.

[0016] If there is a corresponding key in the comment,
One record of the processing flow diagram is input (607), and a search key having the same number as the corresponding key is searched (610). If there is no search key with the same number as the corresponding key in the comment in the record of the process flow diagram, one more record of the process flow diagram is input. If the process flow diagram is searched to the end and there is no record in the process flow diagram that has the search key corresponding to the corresponding key, an error message is output (608, 609) and the next source code is input.

If there is a search key with the same number as the corresponding key in the comment in the process flow diagram, the text of the process flow diagram is inserted into the corresponding comment.

First, between comment symbols (in PL/1, '
/*' to the corresponding '*/') is counted (611), and the text input start position in the process flow diagram is initialized (612). Next, input the text record of the processing flow diagram (61
3). In the text record, the number of characters of the text is stored in advance as data by the processing flow diagram editing section.

If the entire text of the process flow diagram can fit in one line of the comment, the text of the process flow diagram is inserted into the comment (615, 619).

[0020] If the comment does not fit on one line, the text will be folded. First, as many characters as can be input are inserted into the comment (615, 616). Next, one new line is added to the source record and a comment symbol is also added (617). This one line is a comment only line. At this time, the start column position and end column position of the comment symbol are set to match the start column position and end column position of the comment symbol in the record one record before. The text input start column position in the process flow diagram is updated to the next character of the input text (618), and the comment is input again. This is repeated until all the text in the process flow diagram is inserted (614).

The above process is repeated until there is no more source code (605).

If the source code is lost and there is an unprocessed search key in the processing flow diagram, an error message is output (620, 621).

[0023]

According to the present invention, the text described in the processing flow diagram is inserted as a comment in the source code, making it easier to understand the processing contents of the program. This is highly effective in grasping the processing details of a program when investigating the cause of defects in the testing process or when modifying the program as a development base. Furthermore, because easy-to-read source code can be obtained by simply writing only the corresponding keys in comments, it can be expected to reduce the amount of coding man-hours required to write comments. In this way, the reliability, productivity, and maintainability of the program can be improved. Further, there is no need to describe keywords specific to the programming language in the processing flow diagram. That is, the processing flow diagram itself does not depend on any programming language. Therefore, a highly independent processing flow diagram with low dependence on programming language can be obtained.

[Brief explanation of drawings]

FIG. 1 is a configuration diagram showing an embodiment of a system constituting the present invention.

FIG. 2 is a PAD diagram as an example of a processing flow diagram.

FIG. 3 is an example of source code description.

FIG. 4 is an example in which text of a processing flow diagram is inserted into a comment in the source code.

FIG. 5 is a diagram showing an example of the relationship between the PAD, the source code, and the source code after text is inserted by extracting a part of FIGS. 2, 3, and 4;

FIG. 6 is a flowchart showing the processing flow of the embodiment shown in FIG. 1;

FIG. 7 is a flowchart following FIG. 6;

[Explanation of symbols]

1...Display terminal, 2...Main processing section of this system, 3...Processing flow chart editorial department, 4... Source code editorial department, 5... Source code editorial department, 6... Source code comment editorial department, 7...Internal memory, 8...External storage device, 9...Printer.

Claims (1)

[Claims] Claim 1: A processing flow diagram editing section that edits a processing flow symbol that has a search symbol; a source code editing section that edits source code that has a corresponding key in a comment; and a source code translator that translates the source code. and a source code comment editing section for inserting text of a processing flow symbol having a search key that matches a corresponding key in the source code into a source code comment.