JPH0439731A - Comment extracting method - Google Patents

Abstract

PURPOSE:To easily implement with respect to various coding codes by processing comment symbol correspondence information for showing the correspondence of a comment in a program and a symbol in a chart as data on a memory. CONSTITUTION:A comment deciding part 12 for deciding whether a comment is added to a statement in a program or not, and a comment processing part 14 for processing the comment after the comment is decided are provided, and comment symbol correspondence information 13 for showing the correspondence of the comment in the program and a symbol in the chart is processed as data on a memory. In such a way, by only a change of the part of the end of a syntax rule and a flag operation, the correspondence of the comment and the statement can be taken, therefore, it is possible to implement easily with respect to various codes of how to put the comment.

Description

DETAILED DESCRIPTION OF THE INVENTION Field of Industrial Application The present invention relates to a comment extraction method in a chart generation system that generates documents (structured charts) from a program level to a detailed level.

BACKGROUND ART Conventionally, chart generation systems have been created based on coding conventions in software development environments, so this coding convention has been determined to be one, and this convention cannot be easily changed.

Comments in a chart provide a one-to-one correspondence between a chart symbol and a statement written in that symbol. You can understand the processing contents of the module being used.

Problems to be Solved by the Invention Accordingly, for a source program to be converted into a chart, there is a need for a convention specifying how to add comments that can explain the processing contents of the program.

Furthermore, these coding conventions were not meant to be universally applicable; they had to be modified to suit each system and software environment to be created.

In view of the comment extraction method as described above, the present invention aims to enable easy implementation of various coding conventions.

Means for Solving the Problems In order to achieve this object, the present invention includes a comment determining unit that determines whether a comment is added to a statement in a program, and a comment processing unit that processes the comment after the comment determining unit makes a determination. It is equipped with a comment processing section and comment symbol correspondence information indicating the correspondence between comments in the program and symbols in the chart, and is configured to process the comment symbol correspondence information as data on the memory.

Effects of the present invention With the above configuration, the correspondence between comments and statements can be established simply by changing the terminal part of the syntax rules and manipulating flags, so it can be easily implemented for various conventions for adding comments. .

EXAMPLE Hereinafter, an example of the present invention will be described with reference to the drawings.

FIG. 1 is a block diagram showing an embodiment of the comment extraction method according to the present invention.

As shown in FIG. 1, the comment extraction method according to the present invention includes a comment determining unit 12 that determines whether a comment has been added to a statement in a program, and a comment processing unit 14 that processes comments after the determination. , is provided with comment-symbol correspondence information 13 indicating the correspondence between comments in the program and symbols in the chart, and is configured to process the comment-symbol correspondence information 13 as data on the memory.

In the description of the syntax tree of the chart generation syntax analysis unit 15,
Define how to add comments to each terminal symbol,
It is a non-terminal symbol. Furthermore, a flag indicating the presence or absence of a comment is provided, and if there is a comment, the comment flag for that non-terminal symbol is set. In the part of the description that ultimately determines the statement, flags are checked to determine whether or not the statement has comments.

Next, the operation of the comment extraction method according to the present invention will be explained. Note that the parse tree is written using BNF notation (BU
CC[IS-NAUR-FORM r algorithm child data structure-PASCAL program N1klaus M
irth, translated by Takuya Katayama, Japan Computer Association Computer Science Research Book Series 40).

It is also assumed that the comment text is stored in a comment text storage buffer (referred to as a comment buffer).

The coding rules for comments are as shown in Figure 8 (a)
Add comments before the statement.

(b) Comments should be placed next to the statement.

(C) Add comments after the statement.

It can be roughly divided into three types.

The description of the parse tree in the case of the coding convention (a) is as shown in FIG. Further, the processing flow of (a) is shown in FIG.

In FIG. 2, COMMENT represents a comment token returned from the lexical analysis unit 11, STATEMENT represents a statement token other than a comment, and RETURN represents a line feed token.

The processing is as follows.

<1> At 5tat (22 in FIG. 2), if the statement has a comment, a comment flag is set (steps 51 and 52 in FIG. 5).

2> Transition to state expression (21) (step 53).

<3> In expression, if the comment flag is set, the contents of the comment buffer are output (steps 54 and 55); if not, the contents are not output (step 56).

<4> Reset the comment flag (step 57)
).

<5> Have the following token.

The description of the parse tree in the case of the coding convention of [Yes] is as shown in Fig. 3. The processing is as follows. Further, the processing flow of (b) is shown in FIG.

<1> At 5tat (32 in FIG. 3), if the statement has a comment, a comment flag is set (steps 61 and 62 in FIG. 6).

<2> The state transitions to expression (31) (step 63).

<3> In expression, if the comment flag is set, the contents of the comment buffer are output (steps 64 and 65); if not, they are not output (step 66).

4> Reset the comment flag (step 67)
).

<5> Have the following token.

In the case of the coding convention (C), the parse tree is described as shown in FIG. The processing flow of (C) is shown in FIG.

<1> At 5tat (42 in Figure 4), if the statement has a comment, set the comment flag (steps 71 and 72 in Figure 7) <2> Status is e
Transition to xpression (41) (step 73)
).

<3> If the comment flag is set in expression, the contents of the comment buffer are output (steps 74 and 75); otherwise, they are not output (step 76).

<4> Reset the comment flag (step 77)
).

<5> Have the following token.

As mentioned above, the processing is the same regardless of the coding convention, and the description of the parse tree can be handled by modifying the terminal part.

Note that the present invention corresponds to structured chart generation.
Differences in chart types and target processing languages do not limit the scope or gist of the present invention.

Effects of the Invention As described above, the present invention includes a comment determining unit that determines whether a comment is added to a statement in a program, a comment processing unit that processes comments after the comment determining unit determines, The system is equipped with comment symbol correspondence information that shows the correspondence between comments and symbols in the chart, and is configured to process comment symbol correspondence information as data in memory, so rules for how to attach comments can be established. However, with only a slight change to the end of the syntax rules, comments and statements can be made to correspond, making implementation easier.

[Brief Description of the Drawings] Figure 1 is a block diagram showing an embodiment of the comment extraction method according to the present invention, and Figure 2 shows a parse tree when there is a coding convention that "comments are placed before statements." Figure 3 is a conceptual diagram illustrating the operation of an embodiment of the comment extraction method according to the present invention; A conceptual diagram explaining the operation of one embodiment. FIG. 4 shows a syntax parsing tree when there is a coding convention that “comments are added after the statement.” The operation of one embodiment of the comment extraction method according to the present invention is explained. Figure 5 is a processing flowchart of a syntax tree written in accordance with the coding convention ``Comments should be placed before statements.'' Figure 6 is a conceptual diagram of ``Comments should be placed before statements'' written in accordance with the coding conventions. FIG. 7 is a processing flowchart of a syntax tree written in accordance with the coding convention that "comments are placed before statements." FIG. 8 is a conceptual diagram illustrating three patterns of the coding convention. 11... Lexical analysis unit, 12... Comment determination unit, 13... Correspondence information between comments and symbols, 14... Comment processing unit, 15.・・・
...Chart generation syntax analysis section 15.21...
Non-terminal symbol definition part that performs comment processing, 22...
...Nonterminal symbol definition part for determining comments, 31.
...Nonterminal symbol definition part that performs comment processing, 3
2...Nonterminal symbol definition part that performs comment determination, 41...Nonterminal symbol definition part that performs comment processing, 42...Nonterminal symbol definition part that performs comment determination. Name of agent Patent attorney Shigetaka Awano (1 person) Figure 3 Figure 2 Figure 4 Figure (a) Figure (a) Figure 5 (b) Figure 6 (b) Figure (a) Figure 7 Figure (b)

Claims (1)

[Claims] A comment judgment unit that determines whether a comment has been added to a statement in a program, a comment processing unit that processes comments after judgment by the comment judgment unit, and correspondence between comments in the program and symbols in the chart. 1. A comment extraction method comprising: comment symbol correspondence information indicating the comment symbol correspondence information, and processing the comment symbol correspondence information as data on a memory.