JPH04217023A - Source program presenting device - Google Patents

Abstract

PURPOSE:To provide a source program presenting device which can present a source program added with a suitable comment sentence to the reader of the program by outputting the source program in which the comment sentence is buried. CONSTITUTION:This source program presenting device is constituted of a program reading means 10 which reads a source program in which a comment sentence is buried, output control information setting means 12 which sets output control information against a designated comment sentence, comment output discriminating means 14 which discriminates whether or not the comment sentence can become an object to be outputted on the basis of the corresponding set output control information, and program output means 16 which outputs the comment sentence which becomes an object to be outputted together with the main body of the source program.

Description

[Detailed description of the invention]

0001

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a source program presentation device that outputs and presents a source program and comments embedded therein.

[0002] In many cases, a source program is edited using a full-screen editor, and comment statements are embedded in the source program at this time.

0003

2. Description of the Related Art In conventional editors, source programs with embedded comments are displayed as they are, and the comment portions are used as explanations and annotations for understanding the contents of the source program.

[0004] FIGS. 12A, 12B, and 12C show examples of source programs in which comment statements are embedded, and each comment statement has an asterisk mark "" at the beginning of the line.
*” is attached.

Conventionally, all of these comment statements are displayed, so the outline of the source program and the outline of both subroutines are shown from comment statements 1, 2, and 3 in FIGS. 12(A), (B), and (C), respectively. You can understand it, and you can also understand the detailed contents of the source program from other comments.

[0006] Here, if the purpose is to help others or beginners understand the contents of the program, detailed comments may be added to the source program in FIGS. 12(A), (B), (
C) are embedded in large numbers.

[0007] Furthermore, if the developer or expert wants to modify the source program after developing the program or use it in another program, the method shown in FIG.
), (B), and (C) only comment sentences 1, 2, and 3 are embedded.

[0008] As described above, the number and level of detail of comment sentences embedded in a source program vary depending on the level of the person reading the source program.

[0009]

[Problem to be solved by the invention] However, FIG.
When a developer or an expert reads the source programs of (A), (B), and (C), the source list may seem complicated and may actually hinder understanding of the program contents.

[0010] Furthermore, when someone else or a beginner reads the source program in which only comment sentences 1, 2, and 3 in Figs. becomes difficult.

The present invention has been made in view of the above circumstances, and its purpose is to provide a device that makes it possible to present a source program with appropriate comments attached to the reader. .

0012

Means for Solving the Problems In order to achieve the above object, an apparatus according to the present invention is constructed as shown in FIG.

In FIG. 1, a program reading means 10 reads a source program in which a comment statement is embedded, and an output control information setting means 12 sets output control information for a comment statement specified in the read source program. do.

[0014] Then, the comment output determining means 14 determines whether or not the comment sentence is to be outputted based on the output control information of the corresponding setting, and the program outputting means 16 converts the comment sentence to be outputted into the main body of the source program ( Comments are removed).

Note that the judgment criterion information setting means 18 sets in advance information that serves as a judgment criterion for the comment output judgment means 14, and the output control information storage means 20 stores the set output control information in a file separate from the source program. Store.

Further, the output control information insertion means 22 inserts the set output control information into a comment sentence in the source program.

[0017]

[Operation] In the present invention, by arbitrarily specifying comment statements embedded in a source program and setting output control information for each comment statement, the output of each comment statement can be controlled according to the corresponding setting information. Ru.

[0018] Furthermore, by setting information that serves as a standard for determining whether or not a comment text is to be output,
It becomes possible to easily and quickly select the comment text to be output.

Furthermore, the set output control information can be saved by storing it in a file separate from the source program or by inserting it into a comment statement in the source program. It is also possible to automatically set this information by opening the file along with the source program file and reading the output control information at the same time as the source program, or by extracting the output control information from the comment statement of the source program. .

[0020]

DESCRIPTION OF THE PREFERRED EMBODIMENTS Preferred embodiments of the source program presentation apparatus according to the present invention will be described below with reference to the drawings.

In FIG. 2, the input section 32 of the processing device 30
is given keyboard input data, and according to the keyboard input data, data containing the source program is sent from file 34, and data containing the source program is sent to file 3.
From 6 onwards, data used to control the display of comment sentences is read.

The data input to the input unit 32 is sent to the command analysis execution unit 38, and the data of the source program and its edited data are output from the command analysis execution unit 38 to the internal control unit 40.

In the internal control unit 40, the command analysis execution unit 3
The data input from 8 is written to the buffer 42,
The buffer data is sent to the display analysis section 4 via the output section 44.
6 is given.

Further, keyboard input data serving as a display control command for a comment sentence is analyzed by a command analysis execution section 38, and data representing the analysis result is outputted from the command analysis execution section 38 to a display setting section 48.

In the display setting unit 48, initial setting processing is performed regarding the number of comment sentences, display/non-display, display level, display format, etc. according to the output (analysis result) of the command analysis execution unit 38, and resetting processing is performed. is also carried out.

The setting data obtained by the display setting section 48 is sent to the comment text management section 50, and the setting information management table 52 is accessed by the comment text management section 50.

As a result, new setting data is additionally registered in the setting information management table 52, and the already registered setting data is updated.

Note that when the file 36 is opened and display control data is read from that file,
The display control data is registered in the setting information management table 52 as initial setting data.

In FIG. 3, the command analysis execution unit 38,
The operations of the display setting unit 48 and the comment management unit 50 are explained using a flowchart. When the command analysis execution unit 38 receives a command (instruction) indicated by keyboard input data (step 380), its analysis is performed. (Steps 382, 384, 386).

[0030] Then, when setting data (setting information) for registration or updating is created by the display setting unit 48 according to the analysis result (steps 480, 482), the comment text management unit 50 creates the setting data at this time. is newly registered in the setting information management table 52 (step 500), or the previously registered setting data is updated to the setting data (step 500).
Steps 502, 504).

FIG. 4 shows an example of a source program read from the file 34, and a large number of comment sentences are embedded in the source program.

[0032] This source program is read in units of logical lines, and the unit of reading is the display analysis unit 46.
are input in order.

In FIG. 5, the operation of the display analysis section 46 is explained using a flowchart. When the reading unit is input to the display control section 46 (step 460), if the end of input (file end) is not confirmed, ( Step 461), it is determined whether the read unit is comment sentence data or not (Step 462).

[0034] When this data is not a comment statement (when it is the main body of the program: NO in step 462)
) is sent to the output control unit 54 and displayed on the display 56 (or a printer) (step 463).

Further, when the input read unit is comment text data, an inquiry is made to the comment text management unit 50 for setting data corresponding to this (step 464), and the corresponding setting data is stored as setting information. When it is not registered in the management table 52 (step 4)
If YES at 65), the read unit data is sent to the output control section 54 and displayed on the display 56 (step 466).

Then, when the corresponding setting data is registered in the setting information management table 52 (step 465
If NO), the setting data is analyzed (step 467), and the display of the comment text is controlled according to the analysis result (step 468).

FIG. 6 explains the control function for displaying comment statements, and the numbers 1 and 8 of comment statements are displayed at the positions of the comment statements embedded in the source program that are to be displayed. .

[0038] These numbers 1 and 8 are also displayed at the bottom of the source program, and below both numbers 1 and 8, comment sentences corresponding to display numbers 1 and 8 are displayed (inverted here). .

FIG. 7 illustrates the contents of the table at this time, with comment sentences numbered 1, 6, 7, 8, 9, and 10 being displayed.

Furthermore, the display format of the comment text is set by the display analysis section 46 in accordance with the keyboard data input when the display of FIG. 8 is performed.

In the figure, the display level of the comment text is 3 or higher and "normal display" and "footnote display" are selected, and therefore the display shown in FIG. 6 described above is performed.

[0042] If a display level of 4 or higher is selected, only the comment with number 1 will be displayed (see Figure 7), and if display by color is selected, the display level will be displayed in a different color from that of the source program. The comment text is displayed in a different color each time.

Furthermore, when the number specification display is selected, the comment text is not initially displayed, but by specifying the number displayed in the source program (see Figure 6), the corresponding comment text is displayed on a split screen or in a window. will be displayed.

FIG. 9 illustrates a processing procedure for changing the display format of comment sentences. First, keyboard input of display control data for each comment sentence is accepted (step 900).

At that time, as shown in FIG. 10, region marks are automatically added to the beginning and end of the comment, and a display setting window is opened near the comment.

[0046] This window displays the comment number (=
7) Display presence/absence (=display: 1) and display level (=1) are automatically input in advance, and these are changed according to data input from the keyboard as necessary.

[0047] When display control data for all comment sentences are accepted, these setting data are stored in the setting information management table 52 (step 902).
.

Furthermore, when the display format of the comment text is selected as described above (step 904), the setting data is retrieved from the setting information management table 52 (step 9).
06), the display of each comment text is controlled in a selection format according to the corresponding setting data (steps 908, 910).

After that, when editing of the source program is completed (YES in step 912), the data of the source program is output to the file 58 (step 914), and the contents of the setting information management table 52 are output to another file 60. (step 914).

Note that it is also preferable to insert setting data for controlling the display of comment sentences into the corresponding comment sentences, as shown in FIG.

As explained above, according to this embodiment, when comment statements embedded in a source program are specified and display control data is set, display control of each comment statement is performed according to the corresponding setting data. Therefore, the device user can select the displayed comment text appropriately according to his or her own level, and for this reason, those who are unfamiliar with the source program can view the source list with a rich amount of detailed comments. By obtaining the information, it becomes possible to fully understand its contents.

Furthermore, those who are familiar with this source program can easily understand its contents by displaying a simple and easy-to-read source list with only necessary comments.

Furthermore, according to this embodiment, data (see FIG. 8) that serves as a criterion for determining whether or not a comment text is to be output can be set, so the device user can write the comment text according to his/her own level. It becomes possible to select easily and quickly.

[0054] By storing the set display control data in a file 60 separate from the source program (or inserting it into the comment text of the source program), these data can be saved. 36 (58)) together with the source program file 34 (58) and read the display control data at the same time as the source program (or by extracting the display control data from the comment statement of the source program). This makes it possible to automatically set the display control data, thereby eliminating the need for resetting display control data and greatly improving the operability of the device.

Furthermore, since the comment text is displayed in a different position from the source program, it is possible to improve the visibility of the comment text and the source program.

[0056]

[Effects of the Invention] As explained above, according to the present invention, comments embedded in a source program can be selectively output, so a source list with appropriate comment texts that match the user's ability and proficiency level can be output. Therefore, it becomes possible to develop programs in a better environment.

[Brief explanation of the drawing]

FIG. 1 is a diagram explaining the principle of the invention.

FIG. 2 is an explanatory diagram of the configuration of the embodiment.

FIG. 3 is a flowchart illustrating the setting operation of display control data in the embodiment.

FIG. 4 is an explanatory diagram of a source program handled in the embodiment.

FIG. 5 is a flowchart illustrating the comment text display operation of the embodiment.

FIG. 6 is an explanatory diagram of a display screen of a source program and a comment statement in the embodiment.

FIG. 7 is an explanatory diagram of the contents of a setting information management table.

FIG. 8 is an explanatory diagram of the selection effect of the comment text display format in the embodiment.

FIG. 9 is a flowchart illustrating the effect of changing the comment text display format in the embodiment.

FIG. 10 is an explanatory diagram of setting effects of display control data in the embodiment.

FIG. 11 is an explanatory diagram of the operation of inserting display control data into a comment statement of a source program.

FIG. 12 is an explanatory diagram of a source program with comments.

[Explanation of symbols]

30 Processing device 32 Input unit 34 Source program input file 36 Display control data input file 38 Command analysis execution unit 40 Internal control unit 42 Buffer 44 Output unit 46 Display analysis unit 48 Display setting unit 50 Comment statement management unit 52 Setting information management Table 54 Output control unit 56 Display 58 Source program output file 60 Display control data output file

Claims (3)

[Claims] 1. Program reading means (10) for reading a source program in which a comment statement is embedded; output control information setting means (12) for setting output control information for a specified comment statement; A comment output determining means (14) for determining whether or not to be outputted based on output control information of corresponding settings, and a program outputting means (16) for outputting a comment to be outputted together with the main body of the source program. A source program presentation device comprising: 2. Program reading means (10) for reading a source program in which a comment statement is embedded; output control information setting means (12) for setting output control information for a specified comment statement; A comment output determining means (14) that determines whether or not to be outputted based on output control information of corresponding settings, and a determination criterion information setting means (18) that presets information that becomes a determination criterion for the comment output determining means (14). ), an output control information storage means (20) that stores the set output control information in a file separate from the source program, and a program output means (16) that outputs the comment statement to be output together with the main body of the source program. ), a source program presentation device comprising: 3. Program reading means (10) for reading a source program in which a comment statement is embedded; output control information setting means (12) for setting output control information for a specified comment statement; A comment output determining means (14) that determines whether or not to be outputted based on output control information of corresponding settings, and a determination criterion information setting means (18) that presets information that becomes a determination criterion for the comment output determining means (14). ), an output control information insertion means (22) for inserting the set output control information into a comment sentence in a source program, and a program output means (16) for outputting a comment sentence to be output together with the main body of the source program. A source program presentation device comprising: