JPH0944343A - Editor with comment input guide function - Google Patents

Abstract

PROBLEM TO BE SOLVED: To generate a program easy to read and with high visibility by making comment on an appropriate part by defining the condition of a text requiring a comment in an input text and guiding comment input only to a part that coincides with the condition. SOLUTION: This editor 109 provided with comment input guide function comprises a screen I/O means 103, a comment input guide means 104, a source text editing means 107, a comment managing table 105, an analysis information managing table 106 and a source text managing table 108. When a part to which no comment is inputted exists, a syntax analysis range is decided, and syntax analysis is performed in a required range. When it is judged that no syntax error, no comment guide exist and the comment is required to attach, a comment template is outputted, and a user inputs a required comment. A condition to guide the comment is judged from the length of an identifier, the use of a constant value and the assembling of an equation, etc.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to an editor having a comment guiding function, which is a text editor for editing text described in a programming language. The present invention relates to an editor having a comment guidance function suitable for developing a high-performance program.

[0002]

2. Description of the Related Art Conventionally, as an example of a structure editor for generating text according to the grammar of a programming language, for example,
"Structure Editor Kyoritsu Publishing Cornell University (TT
eitelbaum) ”. P. A technique for outputting an S comment template is known.

However, the conventional structure editor has a main purpose to generate a text in accordance with the grammar of a programming language, and in particular, it is rare that a special device for comment description is made.

Therefore, in the above-mentioned prior art structure editor level comment input method, the user himself / herself judges the necessity of the comment for the program text input by the user and inputs the comment.

Further, "Comment sentence input method and comment sentence output method" described in Japanese Patent Laid-Open No. 5-113880 discloses a technique of inputting a comment sentence from a screen of a predetermined format and reflecting it in the source program. ing.

[0006]

Generally, a comment written in a program text is used to supplement the contents of the program text when the meaning that can be read from the program text is insufficient. Yes, enriching the comments makes the entire program easier to read, which in turn improves the quality of the program itself.

On the other hand, in the comment input method according to the above-mentioned conventional technique, since the necessity of comment description is left to the user's judgment, a comment is missing at the time of program creation, a comment is described in an inappropriate place, etc. Therefore, there is a problem that the visibility of the program is deteriorated and the quality of the program may be deteriorated.

Further, the technique described in Japanese Patent Laid-Open No. 5-113880 requires a user to follow the contents of the source program,
Since the comment is not entered, there is still a problem in that the content of the source program and the comment tend to be separated.

The present invention has been made in order to solve the above problems, and its purpose is to describe a comment by a user when a user develops a program using the editor in which a program text is input. Whether or not to do so, in view of the contents of the program, make comments about the parts that need comments without fail, and make the program easy to read, and in turn, make the program creator understand the quality. It is about making expensive programs.

[0010]

In order to achieve the above-mentioned object, the structure of the invention relating to the editor having the comment input guidance function of the present invention is the content of the text to be edited in the editor for editing the text. According to the condition that requires a comment, according to the condition that requires the comment, it has a means for judging the necessity of the comment and a means for guiding the comment input. The necessity of the comment is judged by the means for judging the necessity of the text, and the comment input for the text is guided by the judgment result by the means of judging the necessity of the comment.

More specifically, in the editor having the comment input guide function, the comment input is guided at the timing when the text input to be edited is completed.

[0012] More specifically, in the editor having the comment input guidance function, there is a table for managing whether or not the comment input guidance has been carried out for each line of the text to be edited. It is designed to control whether or not to guide the input.

More specifically, in the editor having the comment input guidance function, the condition required for a comment for the text is that, when the text is written in a programming language, the length of the identifier in the program, It is determined by the use of a constant value in a program and by one or more of the number of discriminators or operators in one sentence in the program.

Another configuration of the editor having the comment input guiding function of the present invention is such that the editor having the comment input guiding function has means for customizing the conditions required by the comment. .

[0015]

According to the present invention, a condition of a text requiring a comment in the input text is determined, and a comment is guided to a portion that matches the condition so that the user can input the comment. Therefore, this makes it possible to add a comment to an appropriate place, so that a program that is easy to read and has good visibility can be created.

Since the conditions for this guidance can be customized, comments can be added to the program according to the programming level and programming style of the user.

[0017]

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS An embodiment according to the present invention will be described below with reference to FIGS. [System Configuration of Editor Having Comment Input Guidance Function] First, the system configuration of an editor having a comment input guidance function according to the present invention will be described with reference to FIG. FIG. 1 is a system configuration diagram of an editor having a comment input guidance function according to the present invention.

An editor 109 having a comment input guiding function of this embodiment (hereinafter, also simply referred to as "editor")
Means screen I / O means 103 and comment input guidance means 10
4. Source text editing means 107, comment management table 105, analysis information management table 106, and source text management table 108.

The screen I / O means has a function as an intermediary with each part of the editor in order to input data from the outside and display the data by the display device 101 and the keyboard 102.

The comment input guide means 104 forms the core of the present invention, and will be described in detail below.

The comment management table 105 and the analysis information management table 106 are tables used by this comment input guide means, and the comment management table manages whether or not comment guidance is carried out for each line. The analysis information management table is a table for managing information necessary for guiding a comment to each line.

The source text editing means 107 and the source text management table 108 are also provided in conventional ordinary editors, and are a means for managing the source text to be edited and a table for managing it.

[Outline of Processing Procedure of Editor Having Comment Input Guidance Function] Next, the outline processing procedure of the editor having a comment input guidance function according to the present invention will be described with reference to FIG. FIG. 2 is a flowchart showing a schematic processing procedure of the editor having the comment input guidance function according to the present invention. Hereinafter, description will be given in order of FIG.

The present invention is an editor for guiding the input of comments in addition to the conventional editor. Therefore, first, it is determined whether or not a line has been added or inserted by text input (S201).

When a line is added or inserted, the comment management table is updated and an entry of the corresponding line is created (S202).

Next, it is judged whether or not there is a comment guidance unimplemented portion (S203).

When there is a part where a comment has not been introduced,
The syntactic analysis range is determined (S204), and the syntactic analysis is performed in a necessary range (S205).

As a result of this syntax analysis, a comment template is output for the necessary lines (S20).
6). Here, the comment template is a template for guiding the input of a comment.

Below, in accordance with the outline of this processing procedure,
The procedure of the embodiment will be described in detail with a use image when the editor is used.

[Details of Processing Procedure of Editor Having Comment Input Guidance Function] (I) Up to Determination of Parsing Range Here, a procedure up to determining the parsing range will be described with reference to FIGS. 3 and 4. FIG. 3 is a diagram schematically showing a text and a comment management table corresponding to the text. FIG. 4 is a diagram schematically showing an example of some texts and a comment management table corresponding to them for the purpose of explaining the determination of the syntactic analysis range.

The comment input guidance of the present invention allows the user to naturally enter a comment in the flow of text editing operation while the user is using the text editor, and the input text can be input without omission. It is called at the end of the text input mode in response to the request for guiding the comment. For example, a specific key may be defined and the comment input guidance process may be called when the key is pressed. (The esc key is normally used as the end key in the text input mode, so it is sufficient to use it.) When such a key is pressed, the comment input guidance process starts, but first, in S201 to S204. Until processing, determine the parsing range of the syntax.

Now, the comment management table shown in FIG. 3 will be described.

The comment management table 105 is a table for managing whether or not the comment guidance is carried out for each line of the text in order to guide the comment to each line of the input text without omission.

As shown in FIG. 3, this comment management table is composed of a line number 303 of each line of text and a comment guidance execution flag 304 (guidance execution: ON, guidance non-execution: OFF). In the figure, the text 301 and the comment management table 302 corresponding thereto are shown. It can be seen that the 10th to 12th lines and the 17th line have been comment guided, and the 13th to 16th lines have not been comment guided. Therefore, the unguided portion of lines 13 to 16 is the target of comment guidance of this editor.

First, it is determined whether or not a line has been additionally inserted when the text is edited (S20).
1). When a line is additionally inserted, an entry corresponding to the additionally inserted line is added to the comment management table (S202). When adding an entry, the comment guidance execution flag 304 is set to OFF as an initial value, which means that guidance has not been carried out.

Next, it is checked whether or not there is a comment guidance unimplemented portion (that is, the comment guidance implementation flag is OFF) in the entry of the comment management table (S203).

If there is no unimplemented one, the processing is completed.

If there is an unimplemented one, S204 to S204
The processing of 206 is performed.

By the way, the text corresponding to the entry for which comment guidance has not been executed is either newly added and inserted, or previously added but not introduced due to a syntax error in the input text. There are types. The latter thing occurs because it is necessary to perform a semantic check for each syntax element in order to perform comment induction, so comment induction is not performed for text with a syntax error. Is.

Therefore, even when there is no additional insertion of text, there is a case where the comment guidance is carried out (correction of the syntax error location, etc.), so that the determination of S203 will be made every time the text input mode ends. .

Next, when there is a comment guidance unimplemented portion, the syntactic analysis range for syntactic analysis is determined. Hereinafter, this step will be described based on a concrete example.

Consider a case where two lines of the assignment statement of the text 401 shown in FIG. 4A are surrounded by IF blocks.

At this time, like the text 403 shown in FIG. 4B, the first two lines 10, 11 of the IF block are displayed.
Insert In the comment management table 404, the 10th and 11th lines have not been comment guided.
Therefore, although the syntax check is performed on the 10th and 11th lines, in this case, since there is no description of the END statement, a syntax error occurs, comment guidance is not performed, and the 10th and 11th lines of the comment management table 404. Eyes off
It remains. Of course, the IF block of this programming language has a structure enclosed by END statements.

Next, the text 40 shown in FIG.
As in 4, the END sentence is inserted on the 14th line.

At this time, the comment guidance unimplemented portion is 1
Lines 0, 11 and 14. However, parsing only these lines will not perform correct parsing. In this case, it is necessary to set the parsing range to 10 to 14 lines, which is the entire IF block, and perform the parsing.

Therefore, it should be noted that the syntactic analysis range here does not necessarily coincide with the comment guidance unimplemented portion.

In consideration of the description having such a block structure, the syntactic analysis range is set from the first line of the comment guidance unexecuted portion to the last line of the comment guidance unexecuted portion. Here, even if there is a comment guidance implementation point in the middle line,
In this way, the syntactic analysis range is set from the first line of the comment guidance unimplemented portion to the last line of the comment guidance unimplemented portion.

In the example of FIG. 4 (c), lines 10 to 14 are the parsing range.

(II) Syntax Analysis Next, the procedure of syntax analysis will be described with reference to FIGS. 5 and 6. FIG. 5 is a schematic diagram showing the data structure of the analysis information management table. FIG. 6 is a diagram showing an example of text in which comment guidance is performed.

First, the analysis information management table referred to in the syntax analysis step will be described with reference to FIG.

The analysis information management table is shown in FIG.
It has the data structure shown in. Here, the line number 501 is a serial number for identifying each line, and indicates that the analysis information corresponding to this line is stored in this table. Presence or absence of syntax error 50
2 is a flag indicating whether or not the input text of this line has a syntax error. The comment description presence / absence 503 is a flag indicating whether or not there is a comment description in the input text of this line.

The comment addition necessity flag is a flag indicating whether it is necessary to add a comment to the input text of this line as a result of the syntax analysis.

Now, in the processing here, the syntax analysis is performed for the syntax analysis range determined as described above,
A comment is guided to a line determined to require comment guidance. That is, if the following conditions are satisfied, the comment addition necessity flag is turned ON.

The condition that requires comment induction may be determined according to the property of the input text. It is also possible to provide a means for the user to customize this condition, as will be explained later.

The condition that requires comment induction can be determined, for example, from the viewpoints of program visibility (program visibility) and readability (readability). From such a point of view, the length of the identifier, the use of a constant value, the assembly of the expression, etc. can be considered as the criterion for determining the necessity of comment addition.

The identifier length means that the number of identifiers used in programming languages such as variable names and function names is within a fixed number. When the identifier is short, it is difficult to read the meaning, and a comment is added.

The use of the constant value means that the constant value is used as it is in the input text. (So-called magic number) Since such a program style makes the program extremely difficult to read, it is recommended to replace it with a macro symbol, but if it violates it, a comment is added to make it difficult to read. Is intended to be alleviated.

The expression assembly means how many discriminators and operators are included in one conditional expression or arithmetic expression. In general, if many expressions like this are included in one expression, the program tends to be very difficult for a programmer to understand, so a comment is added.

The application of such a criterion will be specifically described with reference to FIG. For example, if the length of the identifier is less than 6 characters and the comment guidance is to be performed, the text 6 shown in FIG.
01 described variables (A, B, C), array name (W
K), the subroutine name (SUB1), etc. are all applicable, and therefore all the lines 1 to 4 of this text are subject to comment guidance implementation.

Regarding the use of the constant value, the text 602 shown in FIG. 6 (b) has a constant value "3", 3 in the first line.
Since the constant value "5" is used for the lines, these lines are subject to the comment guidance as lines containing the magic number.

Regarding the assembly of the expressions, for example, when the object of the comment guidance is implemented, it is shown in FIG. 6C that three or more discriminators and operators are included in one expression. The conditional expressions on the first and second lines of the text 603 include three discriminators, and the arithmetic expressions on the fourth and fifth lines include three operators. Becomes

If any one of these conditions is satisfied, that line is subject to comment guidance.

(III) Comment Template Output and Comment Input Next, the procedure of the comment template output S206 will be described in more detail with reference to FIGS. 7 to 9. FIG. 7 is a flowchart showing the procedure of comment template output S206 in more detail. FIG. 8 is a diagram for explaining the relationship between the comment template output and the analysis information management table. FIG. 9 is a diagram for explaining an image in which a comment is guided by using a comment template.

The final process for inducing comments is to output a comment template for a necessary line and allow the user to input a comment. Hereinafter, this will be described in detail in the order of FIG. 7.

This process is repeated for each entry by the number of entries in the analysis information management table (that is, for all the lines to be analyzed for comment guidance).
The processing from 801 to S806 is repeated.

First, by referring to the entry in the comment management table corresponding to the line corresponding to the entry in the analysis information management table, it is determined whether or not the comment guidance has already been executed for that line (S801).

If it has been guided, the process goes to the next analysis information entry.

If the guidance has not been completed, the following steps S802 to S806 are performed.

The following steps S802 to S804 check each item of the analysis information management table.

First, presence / absence of syntax error 50 shown in FIG.
2, it is checked whether or not there is a syntax error in this line (S802). When there is a syntax error, comment induction is not performed for this line.

Next, depending on whether or not there is a comment description 503,
It is determined whether or not there is a comment description in this line (S80
3). When the comment description is already present in this line, the comment guidance is not performed and the comment guidance execution flag 304 of the corresponding line in the comment management table is turned ON.

Next, according to the necessity of comment addition 504,
It is checked whether or not it is determined that a comment is necessary for this line as a result of the syntax analysis in the previous step (S804).
If the result of the comment addition necessity is negative in this line, comment guidance is not performed in this line.

A specific example of the above-described processing of S802 to S804 will be described with reference to FIG.

In this example, 1 shown in the text 901
It is assumed that the IF statement and the assignment statement are inserted before and after the assignment statement on the second line. Although not shown in the figure, the 12th line itself has already been comment-guided.

In the comment management table 902 corresponding to the input text at this time, naturally, only the comment guidance execution flag on the 12th line is turned ON.

The analysis information management tables 903 to 908 are
The value is set for each of the 10th to 15th lines.

In this text 901, for example, 1
Let's look at lines 0, 12, and 13. The conditions for adding a comment are assumed to be those previously defined.

Regarding the 10th line, it can be seen from the comment management table 902 that comment guidance has not been performed. On the other hand, it can be seen from the analysis information management table 903 that there is no syntax error, no comment is written, and comment addition is required. Here, what is required to add a comment is
This is because "A", which is an identifier using less than 6 characters, is used.

Next, regarding the twelfth line, it can be seen from the comment management table 902 that comment guidance has already been performed. Therefore, no reference is made to the analysis information management table.

Finally, regarding the 13th line, it is understood from the comment management table 902 that comment guidance has not been performed. Further, it can be seen from the analysis information management table 906 that there is no syntax error, no comment description, and no comment addition is necessary. Here, the comment addition is unnecessary, the length of the identifier, the use of a constant value,
This is because it is unnecessary to add a comment from any of the conditions for formula assembly.

After all, with respect to the text 901 of this example, comment guidance is carried out for the 10th and 14th lines.

If it is determined in S801 that no comment input guidance has been performed, no syntax error, no comment guidance, and comment addition is required under the conditions of steps S802 to S804, a comment template is output (S8).
05), the user inputs a necessary comment. Then, when the comment is added, the comment guidance execution flag 304 of the comment management table is turned on (S8).
06).

The output of the comment template and the input of the comment will be described with reference to FIG.

Here, the comment of this programming language is described in the part surrounded by "/ *" and "* /".

At this time, the comment template is as shown in FIG.
It is output like the comment template 10 of "/ *"
There is a cursor between the and "* /", and you can enter the text of the comment in insert mode from here. In FIG. 9, 10
The comment is inserted in the line 14, the comment template 10 is output in the line 14, and the text is about to be inserted in the line 14 from now.

When there are a plurality of comment templates, as soon as the description of each comment text is completed on the editor side, the cursor is positioned at the next comment position, and the user follows the comment text to the sequentially guided part. Make input possible.

If the above-described processing is carried out, the comment will be guided to an appropriate portion of the input program text without omission, and the comment will be input. Therefore, the comment is enriched. Easy to read and high quality programs can be created.

[Customization of comment input guide condition]
Next, customization of comment input guidance conditions will be described with reference to FIGS. 10 and 11. FIG. 10 is a conceptual diagram illustrating customization of comment input guidance conditions. FIG. 11 is a schematic view showing a comment input guide condition customization screen.

As described above, the editor having the comment guiding function according to the present invention can judge the comment according to the condition of each line and guide the comment.

By the way, this condition is the nature of the text,
It is desirable to be able to change according to development conditions and user preferences. Therefore, the comment guiding condition can be customized by the user.

This customization can be performed by inputting a customization command from the terminal 709 as shown in FIG. 10, calling the customization screen 110 shown in FIG. 11, and then inputting commands and data from this screen. it can.

From the customize screen 110, it is possible to select whether or not each condition is used for the comment addition necessity judgment processing by clicking the button 111 with a mouse or the like. This is set in the judgment condition management flag 709. Reflected.

Further, from this screen, the length of the identifier, the limit of the number of discriminators and operators in one sentence can be input, and this is reflected in the determination condition data 710. In FIG.
The length of the identifier is input as 8, and the upper limit of the number of discriminators and operators is input as 4.

Then, the judgment condition management flag 709 is used to judge whether the comment addition necessity of each item is necessary or not in each condition item judgment process executed in the comment necessity judgment process 703 shown in FIG. At this time, the condition for inducing a comment can be customized by using the judgment condition data 710. Therefore, the comment necessity determination condition items can be customized in various ways, and the comment guidance suitable for the programming level and programming style of each user can be performed.

[0095]

According to the present invention, in the editor for inputting the program text, when the user develops the program using the editor, the user can choose whether to write a comment or not, From the viewpoint of the content, it is possible to make a comment for a portion that needs a comment without fail, to make an easy-to-read program, and in turn, to make the program creator create a high-quality program.

[Brief description of drawings]

FIG. 1 is a system configuration diagram of an editor having a comment input guidance function according to the present invention.

FIG. 2 is a flowchart showing a schematic processing procedure of an editor having a comment input guidance function according to the present invention.

FIG. 3 is a diagram schematically showing a text and a comment management table corresponding to the text.

FIG. 4 is a diagram schematically showing an example of some texts and a comment management table corresponding to the texts for explaining the determination of the syntactic analysis range.

FIG. 5 is a schematic diagram showing a data structure of an analysis information management table.

FIG. 6 is a diagram showing an example of text in which comment guidance is performed.

FIG. 7 shows a procedure of comment template output S206.
It is a flowchart in which the details are extended.

FIG. 8 is a diagram for explaining a relationship between a comment template output and an analysis information management table.

FIG. 9 is a diagram for explaining an image in which a comment is guided by a comment template.

FIG. 10 is a conceptual diagram illustrating customization of comment input guidance conditions.

FIG. 11 is a schematic view showing a comment input guide condition customization screen.

[Explanation of symbols]

10 ... Comment template 101 ... Display device 102 ... Keyboard 105, 302, 402, 404, 406, 902 ... Comment management table 303 ... Line number 304 ... Comment guidance execution flag 106, 501, 903-908 ... Analysis information management table 109 ... Editor 110 having comment input guidance function 110 ... Comment input guidance condition customization screen 111 ... Buttons 301, 401, 403, 405, 601 to 603, 9
01 ... text

 ─────────────────────────────────────────────────── --- Continuation of the front page (72) Inventor Hisatoshi Kobayashi 5-2-1 Omika-cho, Hitachi-shi, Ibaraki Hitachi Process Computer Engineering Co., Ltd. (72) Fumio Shimizu 5-chome, Omika-cho, Hitachi-shi, Ibaraki No. 1 in Hiritsu Process Computer Engineering Co., Ltd. (72) Inventor Yuki Takahashi 5-2-1, Omika-cho, Hitachi-shi, Ibaraki Hitachi Ltd. Omika factory (72) Inventor Takashi Owaki Omika, Hitachi-shi, Ibaraki 5-2-1, Machi Incorporated company Hitachi, Ltd. Omika factory

Claims (5)

[Claims] 1. In an editor for editing text, a condition for requiring a comment is determined according to the content of the text to be edited, and means for determining the necessity of the comment according to the condition requiring the comment. , A means for inducing comment input, a means for judging the necessity of the comment according to the content of the text, a necessity for the comment for the text, and a means for judging the necessity for the comment An editor having a comment input guide function, which guides a comment input for the text according to the judgment result. 2. The editor having a comment input guide function according to claim 1, wherein the comment input guide is performed at the timing when the text input to be edited is completed. 3. A table that manages whether or not comment input guidance has been implemented for each line of text to be edited, and whether or not to perform comment input guidance is controlled by the table. An editor having a comment input guidance function according to any one of claims 1 and 2. 4. The condition that a comment for the text requires is that, when the text is written in a programming language, the length of an identifier in the program, the use of a constant value in the program, the The editor having a comment input guide function according to any one of claims 1 to 3, wherein the editor is defined by one or more of the number of discriminators or operators in one sentence. 5. An editor having a comment input guiding function according to claim 1, further comprising means for customizing a condition required by the comment.