JPH06124199A - Source code comment editor - Google Patents

Abstract

PURPOSE:To simultaneously perform editing work while comparing a source code and a comment on a display picture and further always in the state of corresponding for each line. CONSTITUTION:The class of a character inputted from a keyboard 2 is discriminated by an input character discrimination part 12 and when it is discriminated that a cursor is moved in a line direction, an editing part 13 simultaneously moves the cursor or performs scrolling in the designated line direction on a source code window 31 and a comment window 32 by using a source code display part 111 and a comment display part 112. When a line shift code is discriminated, a line shift code is inputted to a cursor position on the currently selected window among the windows 31 and 32 and at the same time, the line shift code is also inputted to the end of the character string of the correspondent line on the other window. The edited result of the editing part 13 is preserved in different files corresponding to the source code and the comment.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a source program creating tool in software development, and more particularly to a source code / comment editing apparatus suitable for simultaneously editing a source code and its comment.

[0002]

2. Description of the Related Art In software development, when creating a source program, from the standpoint of maintaining the development, it is better to put a comment at each step of the source program so that people other than the creator can easily understand. However, adding comments at the same time as the source program is created increases the number of lines in the source program, and since comments are inserted between the source codes, it becomes difficult to read the source program and development efficiency deteriorates. Become. Therefore, some authors have used a method in which only a comment is entered after the source program is completed, or a comment is only incompletely entered.

[0003]

As described above, conventionally, when a comment is added to each step of a source program, the comment is inserted between the source codes at the stage of creating the source program. There was a problem that the source program became difficult to read and the development efficiency deteriorated.

The present invention has been made in view of the above circumstances, and an object thereof is to provide a source code / comment editing apparatus capable of simultaneously performing editing work while comparing a source code and a comment on a display screen. . Another object of the present invention is to provide a source code / comment editing device capable of performing editing work in a state where a source code and a comment are always associated line by line.

[0005]

According to the present invention, a source code is displayed in a first window and a comment for the source code is displayed in a second window, and an input for inputting characters and the like. Means, and input character discrimination means for discriminating the type of the input character from the input means,
It is characterized in that it is provided with an editing means for creating / editing a source code on the first window and creating / editing a comment on the second window according to the result of the input character judging means. is there.

If the input character is a control character indicating the cursor movement in the line direction, the same cursor movement or scroll is performed in the specified line direction on both the first and second windows. , If it is a line feed code, enter the line feed code not only on the cursor position on the currently selected window of the first and second windows but also on the corresponding line on the other window, and not the control character. In the case of a normal character, the editing means is also provided with a function of inputting an input character at the cursor position on the currently selected window.

[0007]

In the above structure, since the source code is displayed in the first window and the comment is displayed in the second window at the same time, the source code and the comment are created while comparing the source code and the comment. Can edit.

When the input character is a control character indicating the movement of the cursor in the line direction, the first window and the second window are displayed.
In the window of, the same cursor movement or scrolling is performed at the same time, and when the input character is a line feed code, the line feed code is, of course, input at the cursor position on the currently selected window. Since the line feed code is also input to the corresponding line on the other window, it is possible to work with the source code and the comment always corresponding to each line. If such characteristic control is not performed, it is possible to perform editing work on the second window (or the first window) while looking at the first window (or the second window). Even the source code on the first window and the second
Since it does not necessarily correspond to the comment on the window, the scroll operation in one window needs to be performed in the other window.

[0009]

1 is a block diagram showing the configuration of a source code / comment editing apparatus according to an embodiment of the present invention.

In FIG. 1, 1 is a CPU which is the center of a source code / comment editing device, 2 is a keyboard for inputting characters and the like, and 3 is a display device used for displaying source programs and the like. On the display screen of the display device 3, a source code window 31 for displaying source code is displayed.
And the comment window 32 for displaying the comment are secured so as to form a pair on the left and right (at the time of creating / editing the source program). Here, the windows 31 and 32 have the same number of lines (number of lines) N. 4 is a file in which the source code is saved (hereinafter, source code file),
Reference numeral 5 is a file in which comments are stored (hereinafter referred to as a comment file). The CPU 1 includes each functional element of a display unit 11, an input character determination unit 12, an editing unit 13, and a file input / output unit 14.

The display unit 11 controls screen display on the display device 3, and has a source code display unit 111 and a comment display unit 112. Source code display 1
Reference numeral 11 displays the source code created and edited by the editing unit 13 in the source code window 31. The comment display unit 112 also displays the comment of the source code in the comment window 32.

The input character discriminating unit 12 discriminates the type of the character input by the keyboard 2. The editing unit 13 creates / edits the source code on the source code window 31 and creates / edits the comment on the comment window 32 according to the determination result of the input character determination unit 12. The file input / output unit 14 inputs and outputs the source code and the comment between the source code file 4 and the comment file 5 and the editing unit 13. Next, the operation of the configuration of FIG. 1 will be described with reference to the flowchart of FIG.

Now, it is assumed that the source code file 4 stores the source code to be edited, and the comment file 5 stores the comment of the source code to be edited.

Here, the source program developer operates the keyboard 2 to input a control character for instructing the reading of the file and a character string for designating the target file for editing the source code and the comment. And

When a control character for instructing the reading of a file is input from the keyboard 2, the input character discriminating unit 12 notifies the file input / output unit 14 of that fact, and an input character string following the control character, that is, Pass a character string that specifies the target file.

The file input / output unit 14, when the files designated by the input character string passed from the input character discriminating unit 12 are the source code file 4 and the comment file 5,
That is, when the designated file exists, the source code from the designated source code file 4 and the comment from the comment file 5 are read and passed to the editing unit 13.

Then, the editing unit 13 uses the source code display unit 111 and the comment display unit 112 in the display unit 11 to secure the source code read by the file input / output unit 14 on the display screen of the display device 3. Similarly, in the source code window 31, the comment is displayed in the comment window 32 secured on the display screen of the display device 3. Here, the number of lines of source code and comments is
If the number of rows N in the windows 31 and 32 is exceeded,
First, N lines starting from the first line are displayed. At this time,
The cursor (character input cursor) is the window 31, 3
It is displayed in the first digit of the first line in 2.

In such a state, when the source program developer performs an operation for inputting a character using the keyboard 2, the corresponding character is input from the keyboard 2 to the input character discriminating unit 12.

The input character discrimination unit 12 checks the input character from the keyboard 2 and discriminates whether or not it is a control character (step S1). If it is a control character, the input character determination unit 12 determines the type of the control character (step S2). This control character includes a line feed code, a control character indicating up cursor movement ([↑]), a control character indicating down cursor movement ([↓]), left cursor movement ([←])
There is a control character that indicates, a control character that indicates right cursor movement ([→]), a control character that specifies saving of the source code currently being created / edited and a comment, and the like.

When the input character discriminating unit 12 discriminates that the input character is a control character indicating upward cursor movement or downward cursor movement (cursor movement in the line direction), the editing unit 13 displays the source code. Using the section 111 and the comment display section 112 on both the source code window 31 and the comment window 32,
The same character input cursor movement or scrolling in the upward or downward direction (the designated line direction) is simultaneously performed (step S3). Here, whether the cursor is moved or scrolled is determined by the position of the character input cursor in the windows 31 and 3.
It depends on which line in 2. For example, in the case of a control character indicating the movement of the lower cursor, scrolling occurs if the character input cursor position is on the last line in the windows 31 and 32, and cursor movement otherwise. When it is determined that the character is a control character indicating left or right cursor movement (cursor movement in the digit direction), only the character input cursor on the currently selected window is moved in the designated digit direction.

Further, when the input character discriminating unit 12 discriminates that the input character is a line feed code, the editing unit 13 has a source code window 31 and a comment display unit managed by the source code display unit 111. In the comment window 32 managed by 112, a line feed code is input at the character input cursor position on the currently selected window, and the character input cursor is moved to the first column of the next line (step S4). At the same time, the editing unit 13 also applies to the end of the character string of the corresponding line (that is, the line where the character input cursor currently exists) on the other window (or the first column of the line if no character string exists). , A line feed code is input, and the character input cursor is moved to the first digit of the next line (step S5). The windows are selected by, for example, using a mouse (not shown) to move the mouse cursor into a desired window and clicking the mouse button.

By the above simultaneous cursor movement or simultaneous scroll operation and the operation of inputting a line feed code in the other window when the line feed code is input in one window, the source code is obtained. Comments can be associated with each line.

When the input character discriminating unit 12 discriminates the input character as a normal character which is not a control character, the editing unit 13 selects the input character from the source code window 31 and the comment window 32 at present. Input is made at the character input cursor position on the selected window (step S6).

It is assumed that the developer of the source program eventually operates the keyboard 2 to input a control character for instructing saving in a file and a character string for specifying the target file.

When a control character for instructing the file to be saved is input from the keyboard 2, the input character discriminating unit 12 notifies the file input / output unit 14 of that fact, and the input character string following the control character is input. That is, a character string designating the target file is passed. Here, assuming that the source code file 4 and the comment file 5 are specified as the target files, the file input / output unit 14 uses the source code created and edited by the editing unit 13 up to that point as the source code file. 4 and similarly, the comment is stored in the comment file 5, respectively. The source code saved in the source code file 4 and the comment saved in the comment file 5 are edited again by the editing unit 1.
It can be an edit target according to 3.

[0026]

As described above in detail, according to the present invention,
The source code is displayed in the first window, the comment of the source code is displayed in the second window, and the source code is created / edited in the first window according to the content of the character input from the input means. Since the comment is created and edited on the window of No. 2, it is possible to edit at the same time while comparing the source code and the comment on the display screen.

Further, according to the present invention, when the input character from the input means is a control character indicating the cursor movement in the line direction, it is moved in the designated line direction on both the first and second windows. When the same cursor movement or scroll is performed and the line feed code is used, the cursor position on the currently selected window of the first and second windows as well as the corresponding line on the other window is displayed. Since the line feed code is input, the editing work can be performed with the source code and the comment always corresponding to each line. As a result, the maintainability of the source code in software development is improved, and the source program can be efficiently created.

[Brief description of drawings]

FIG. 1 is a block diagram showing the configuration of a source code / comment editing device according to an embodiment of the present invention.

FIG. 2 is a flowchart for explaining the operation of the embodiment.

[Explanation of symbols]

1 ... CPU, 2 ... keyboard (input means), 3 ... display device 3, 4 ... source code file, 5 ... comment file, 11 ... display section, 12 ... input character discriminating section, 13 ... editing section, 14 ... file entry Output section, 31 ... Source code window (first window), 32 ... Comment window (second window), 111 ... Source code display section, 112 ... Comment display section.

Claims (3)

[Claims] 1. A display means for displaying a source code in a first window and a comment for the source code in a second window, an input means for inputting characters and the like, and an input by this input means. An input character discriminating means for discriminating the type of the inputted character, and the source code is prepared and edited on the first window according to the discrimination result of the input character discriminating means, and the comment is prepared on the second window. A source code / comment editing device comprising: editing means for editing. 2. The editing means controls the display means to control the display means when the input character determining means determines that the input character is a control character indicating a cursor movement in a line direction. If the same cursor movement or scrolling is performed in the specified line direction on both the second window and the second window, and it is determined that the line feed code has occurred,
In addition to the cursor position on the currently selected window of the first and second windows, the line feed code is input to the corresponding line on the other window, and it is determined that the character is not a control character but a normal character. 2. The source code / comment editing device according to claim 1, wherein in the case where the input character is input, the input character is input to the cursor position on the currently selected window of the first and second windows. 3. When the input character determination means determines that the input character is a control character indicating storage,
The source code and the comment created and edited by the editing means are output to independent files, and when this file is specified, the contents are input as an edit target and passed to the editing means. 3. The source code / comment editing device according to claim 2, further comprising output means.