JPH05298081A - Specification extracting device - Google Patents

Abstract

PURPOSE:To generate specifications by extracting a prescribed part from specifications and programs which are stored in the same file. CONSTITUTION:The input file which is stored in a storage device 1 and where the source code generated in the C language and specifications are unified is sent to a specification extracting device 2. The device 2 subjects the input file to structure analysis in a structure analysis part 3 to extract comment sentences between '/*' and '*/', a part including a header file from the part described in the C language, and parts of interface of functions and sends them to a sentence shaping part 4. The part 4 properly adds a sentence shaping command or the like for sentence shaping mechanism (for example, nroff) to given contents and outputs them as an output file 6. It is supplied to a UNIX online manual mechanism 7, thus generating the specifications shaped in a prescribed form.

Description

Detailed Description of the Invention

[0001]

BACKGROUND OF THE INVENTION 1. Field of the Invention The present invention relates to a specification extracting device, and more particularly to a device for extracting electronically stored comment sentences such as manual sentences (specifications).

[0002]

2. Description of the Related Art When a certain module in a program is used, a specification (manual) specifying how to use the module is required. As a method of supplying the specifications, in addition to a normal printed matter, the FD may be supplied in a state of being stored in an electronic storage medium such as an FD, or further, as an online file like an online manual, a computer system. In some cases, the user can refer to the contents of the specifications from a terminal or the like while using the system as needed. Then, conventionally, the program (source code) and the specifications are stored in separate files.

[0003]

By the way, since the contents of the program module are appropriately changed at the development stage of the program or when the program is improved, it is necessary to correct the contents of the specification depending on the changes. Occurs. However, as mentioned above, in the past, the specifications and the program were stored in separate files, so when changing the specifications, it is necessary to close the program file and then open the specification file. This not only complicates the management and processing, but also may forget to change the contents of the specifications. In addition, one file may be lost or one or the other may be forgotten when distributing the program.

The present invention has been made in view of the above background, and its purpose is to extract a predetermined portion in a file to create a specification sheet and correct the contents of the program. Accordingly, it is an object of the present invention to provide a specification extraction device capable of preventing occurrence of omission of necessary correction of specification documents, facilitating management of specification documents and programs, and certainly distributing both.

[0005]

In order to achieve the above object, in a preprocessing device for a neural network according to the present invention, first, a program (source code) and a specification are stored in one file and managed. I decided to do it. Then, a device for extracting the part related to the specifications from the file was provided. As a device for extracting the specifications,
Syntactic analysis means for receiving the contents of an input file in which the program and the specifications are integrally stored, parsing the given input file, and extracting a portion related to the specifications. Receiving the output of the syntactic analysis means, a predetermined processing process is performed on the content of the extracted part related to the specification so as to follow the format of the specification,
And a text shaping means for outputting.

[0006]

When the module in the program that requires only the specifications is used, the input file is parsed to extract the source of the specifications such as comments. Then, the extracted contents are shaped by the sentence shaping means. Then, the shaping result is directly or further subjected to a predetermined process to create a specification in a predetermined format.

As described above, by using the present apparatus, even if the specifications and the program are stored in the same file, the specifications can be created by extracting a predetermined area of the file. Collective management is performed.

[0008]

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENT A preferred embodiment of a specification extracting device according to the present invention will be described in detail below with reference to the accompanying drawings. First, the present invention has a first feature that the source code (function) of the program, which has been conventionally stored in another file, and the specification are integrated and stored in one file. Since only the specifications are required when using the actual program (system), a means for extracting only the parts related to the specifications from the file and providing it to the users etc. was provided. The second
It is a feature of. The specific configuration is as follows.

FIG. 1 shows a first embodiment of a specification extracting device according to the present invention.
An example is shown. As shown in the figure, in this example, the source code and the specifications are stored in the storage device 1 as one file (input file). Then, a specific example thereof is shown in FIG. That is, the comment statement that is the basis of the specification is
Along with the titles such as and "STRUCTURES", the explanation about the contents is described between "* /" and "/ *", and the source code is described in C language after "Include files". It is one file.
Then, this input file is sent to the specification extracting device 2.

The specification extraction device 2 includes a structure analysis unit 3 and a sentence shaping unit 4, and the structure analysis unit 3 is adapted to extract a description necessary for a specification from an input file. In addition, the sentence shaping unit 4 is configured to output the data extracted by the structure analysis unit 3 after performing a predetermined processing process in accordance with the standard format of the specification. It has the function shown in.

That is, the structure analysis unit 3 first searches the input file for a comment sentence which is the text of the specification. Specifically, in the case of the UNIX input file, the area between "/ *" and "* /" is the comment text area, so that "/ *" and "*"
/ "Is detected, and the contents ((a) in the figure) described in between are detected. And from the extracted sentences,
The words that are the items of the specifications, such as "DESCRIPTION" and "STRUCTURES", are further extracted. The word is stored in the keyword file 5 linked to the syntax analysis unit 3.

[0012] Also, from the part written in C language, the header
Extract the part that includes the file ((b) in the figure) and the interface part of the function ((c) in the figure). And further, each of these extracted contents (a) ~
From (C), the words to be output with the emphasized characters stored in the keyword file 5 are extracted.

On the other hand, the sentence shaping unit 4 is used for sentence shaping for a sentence shaping mechanism (for example, nroff) included in the UNIX online manual mechanism with respect to the one extracted by the structure analysis unit 3 as described above. Command (".nf",
".Br", ".in" ...) Other various commands ("\ f",
".SH" ...), etc. are added appropriately according to the standard format of the online manual, and then output. The file to which the various commands are added in this way becomes the output file 6, and an example thereof is shown in FIG.

Then, the output file 6 is supplied to the UNIX online manual mechanism 7 where it is executed by the command "man" to create a specification formatted in a predetermined format as shown in FIG. The underlined parts in the figure are keywords and are emphasized characters.

Therefore, in this example, the specifications and the source
Since the code and the code are stored in one file, for example, when the source code is modified by opening the file, the contents of the specification can be modified with the file kept open. That is, since the file opening / closing work or the like is not required to correct the specifications, the work is easy. In addition, since the correction can be easily performed in this way, it is possible to prevent forgetting to make the correction. Further, since it is stored in one file, its management becomes simple and one of them is not lost.

On the other hand, when using the module in the program which requires only the specifications, the specifications extraction device 2 according to the present invention is operated to create the specifications which are shaped in a predetermined format. Note that once the specification extracting device 2 is operated to create the output file 6, the contents of the output file 6 are stored and held. Therefore, unless the contents of the input file are changed, the specifications based on the output file 6 are used. Will be created. Therefore, if the portion of the input file related to the contents of the specifications is changed, the specification extraction device 2 must be operated to create the latest specifications.

FIG. 5 shows a second embodiment of the specification extracting device according to the present invention.
An example is shown. This example is basically the same as that of the above-described first example, but if only the source code part is modified to more surely prevent forgetting to modify the comment sentence, It detects it and issues a predetermined warning to the rectifier.

That is, as shown in FIG.
By operating the editor 11 via the input device 10 such as a mouse, the contents of the input file in the storage device 1 are read out, and after the processing such as correction / addition is appropriately performed, the file of the new contents is written in the storage device 1. It is like this. As a result, edit processing is performed.

Further, in this example, at the time of reading, the contents of the read file (old file) are copied, the file name is changed, and the contents are temporarily stored in the storage device 1. At this time, the newly set file name is added with a predetermined character or the like after the file name of the read input file so that the file name does not overlap with the file names of other files stored in the storage device 1. Or a predetermined document name for correction (in this case, the document name is not used as the document name of a normal file) may be used.

Further, a difference detecting device 12 is connected to the storage device 1, and the difference detecting device 12
The contents of the old file stored in the storage device 1 are compared with the contents of the new file stored after the editing process, and if there is a predetermined difference, a predetermined message is displayed on the display device 13 such as a CRT or a liquid crystal display. It is adapted to output or to issue an operation signal to the specification extracting device 2. Further, the old file stored in the storage device 1 is deleted after the completion of the predetermined process.

It should be noted that the display device 13 is also adapted to display the work content during the editing process. Further, since the specific configuration and function of the specification extracting device 2 and other devices are the same as those of the above-described first embodiment, the description thereof will be omitted.

Next, the operation of the above-mentioned second embodiment will be described. As shown in FIG. 6, when the input device 10 and the editor 11 are used to modify an input file, first, when the input file is read, the contents are copied as a file with a different name, and the old file is copied. Is stored in the storage device 1 (S101).

Next, a predetermined edit process is performed on the read new file, and the changed contents are stored in the storage device 1 as a new file. Then, the difference detection device 12 is used to compare and detect whether or not there is a difference in the contents of the old and new files (S102, 103). And if there is a difference in content, the function (source code)
It is determined whether or not only the correction is made, and if at least the comment statement is corrected, the specification is changed, so the specification extraction device 2 is started and an output file is created based on the new file. (S104-10
7). Then, after that, the old file is erased, and the process ends (S108). By doing so, when a predetermined change is made to the input file, a specification having new contents is automatically created, so that the specification in the output file 6 is updated (by the specification extracting device 2). It is possible to prevent forgetting to operate. That is, although the comment text in the input file is modified to create the original specifications that correspond to the latest functions, the output file remains the old content and the user is informed of the old content. The specifications will not be supplied.

If only the function is changed and the comment statement is not modified, a message requesting the change of the comment statement is output to the display device 13 (S109). By calling the creator's attention with such a message, it is possible to prevent forgetting to change the comment text in the input file.

However, even when only the function is changed, it is necessary to change the comment statement which is the source of the specification in the case of a change in a part not related to the specification or a bug correction. It may not be. Therefore, after outputting the above message, the system waits for a reply from the user (which is performed via the input device 10) and performs a predetermined process according to the content of the reply (110, 111). The predetermined processing is, for example, when the content of the reply is "correction of comment text is required", the process jumps to step 101 to perform the edit processing again, or "correction of comment text is unnecessary. In addition, when it is not necessary to create a new specification, the process jumps to step 108, and "comment statement is not required to be modified, but new specification is required to be created (for example, when the interface part of the function is modified, etc.). ) ”, Jump to step 107, and so on.

In the present invention, in addition to the above example, for example, a difference is detected (S103), and if there is a difference,
Regardless of the content, the process may immediately jump to step 107 (in this case, omit S104 to 106, 109 to 111) and always start the specification extracting device to always create the latest output file. On the contrary, if there is a difference, the process may jump to step 109, display a predetermined message on the display device 13, and perform a process corresponding to the reply from the user (in this case, , S104 to 106 are eliminated), and various modifications can be made.

FIG. 7 shows a third embodiment of the specification extracting device according to the present invention.
The principal part of an Example is shown. As shown in the figure, in this example, the function / configuration of the difference detection device 20 is different from that of the second embodiment described above. That is, the difference detection device 20 includes a syntax analysis unit 20a, a comparison unit 20b, a state determination unit 20c, and a processing unit 20d. In the syntax analysis unit 20a,
The comment parts (A), (A '), the function interface parts (B), (B') and the function realization parts (C), (C ') are extracted for each of the new file and the old file. Is becoming The above-mentioned function interface part is a part of the function part described in C language that includes the header file and the interface part of the function, but is the part that is directly extracted to the specifications. (Portions indicated by (b) and (c) in FIG. 2).

Further, the comparison section 20b compares the contents of the old and new files appropriately divided as described above, and detects the difference. Then, the detection result is sent to the state determination unit 20c, and the content of the edit process is determined. That is, for example, "if there is a difference between A and A ', only the comment sentence is corrected", it is judged which part has been corrected from the presence or absence of the difference, and it is determined according to the state. Determine the treatment. That is, it can be said that it is necessary to operate the specification extraction device 2 and update the output file without fail when the comment statement is corrected, and when the comment statement is not corrected, the function implementation unit If it has been modified, it may be necessary to modify the comment text by re-editing. If only the function interface part has been modified, the specification extraction device 2 must be operated and output. It can be said that the file needs to be updated. Also, if no modification processing has been done (there is no difference), the file is simply opened and closed without modification, so
All you have to do is delete the old files.

Then, the status signal is sent to the processing unit 20d, and the processing unit 20d responds to the status signal by the storage device 1.
To the specification extracting device 2, or to the editor 11 to send a command signal to reload the input file. .. Then, if necessary, the result of the judgment is displayed as a message on the display device,
The current processing status (judgment result) is notified to the user.

Next, the operation of the above-mentioned embodiment will be described. As shown in FIG. 8, when the input file is corrected using the input device 10 and the editor 11, the input file is first read out. At times, the contents are copied as a file with a different name and stored in the storage device 1 as an old file (S201).

Next, a predetermined edit process is performed on the read new file, and the changed contents are stored in the storage device 1 as a new file (S202). Then, the old and new files are respectively parsed and separated into a comment part, a function interface part, and a function realization part, and it is judged whether or not there is a difference between the old and new files in each unit (S203, 204).

From the judgment result, if there is a change in the comment parts A and A ', the specification extracting device is activated to execute the specification extracting process regardless of whether the other parts are changed or not, and then the old file is deleted. It ends (S205, 208, 209).

If there is no change in the comment section,
At the next step 206, the function interface part B,
It is determined whether or not only B'has been changed. If there is a change, the process jumps to step 208 in the same manner as described above, and after the specification extraction processing is performed, the old file is erased and the processing ends.

Then, when only the function interface unit is not changed, that is, when the function realization unit is also changed together with the function interface unit, or only the function realization unit is changed (both may not be changed). In the next step 207, it is determined whether or not both the function interface part and the function realization part have been changed. If there is no change, the contents of the old and new files are all the same, so the specification extraction processing is performed. Since it is not necessary to create an output file (specification document), the old file is erased as it is, and the process is ended (S207, 109). If there is a change (meaning that there is at least a change in the function implementation unit), it is determined that the comment statement needs to be modified, and the process returns to step 201. As a result, the comment text is automatically re-edited so that the comment text is never forgotten. Then, if the comment sentence is corrected at this stage, the determination at step 205 jumps to step 208 to perform the specification extraction processing. Therefore, when the comment text modified this time and the function interface part are modified in the previous edit process, those parts are also subject to the specification extraction process at the same time, and a new specification document is created by one extraction process. become.

If, at the time of this re-editing, no correction is made, including the comment text, the contents of the new and old files will be the same, so the process skips to step 209 without performing the specification extraction process. Erase the file and exit. Therefore, although not shown, when returning from step 207 to step 201, it is determined whether or not the function interface unit has been modified, and if it has been modified, the specification extraction processing is performed once, and then step 201 is performed. It is desirable to add a step of returning (if it has not been corrected, directly returning to step 201).

With such a configuration, it is possible to avoid forgetting to correct the comment text and to forget to create a new specification by extracting the specification when a portion related to the specification is corrected. The specifications that are suitable for the source code will always be created. Since the other configurations and operations are the same as those of the above-described embodiments, the description thereof will be omitted.

In each of the above-mentioned embodiments, the UNI
Although an example in which X is used and the specification is provided online is explained, the present invention is not limited to this, and the specification can be stored by storing the output file in an electronic storage medium such as an FD. It may be provided, and the language used is not limited to UNIX, but any other language can be used.

[0038]

As described above, in the specification extracting apparatus according to the present invention, a part related to the specification is extracted and a specification is extracted from the file in which the contents related to the program and the specification are integrally stored. Can be created. Moreover, because both are stored in the same file,
The management becomes simple, it is possible to prevent omission of amendment of the specification that is necessary when the content of the program is amended, and both can be distributed without fail.

[Brief description of drawings]

FIG. 1 is a block diagram showing a first embodiment of a specification extracting device according to the present invention.

FIG. 2 is a diagram showing an example of an input file.

FIG. 3 is a diagram showing an example of an output file.

FIG. 4 is a diagram showing an example of a specification according to an online manual.

FIG. 5 is a block configuration diagram showing a second embodiment of the specification extraction device according to the present invention.

FIG. 6 is a flowchart showing the operation of this embodiment.

FIG. 7 is a block configuration diagram showing a second embodiment of the specification extracting device according to the present invention.

FIG. 8 is a flowchart showing the operation of this embodiment.

[Explanation of Codes] 1 storage device 2 specification extraction device 3 structure analysis unit 4 sentence shaping unit 6 output file 7 online manual mechanism unit 10 input device 11 editor 12, 20 difference detection device 13 display device

─────────────────────────────────────────────────── ───

[Procedure amendment]

[Submission date] July 9, 1992

[Procedure Amendment 1]

[Document name to be amended] Statement

[Correction target item name] 0005

[Correction method] Change

[Correction content]

[0005]

In order to achieve the above object, in the specification extracting apparatus according to the present invention, first, the program (source code) and the specification are stored and managed in one file. .. Then, a device for extracting the part related to the specifications from the file was provided. As a device for extracting the specifications, the contents of the input file in which the program and the specifications are stored as one unit are received, and the given input file is parsed and related to the specifications. A syntactic analysis unit for extracting a portion to be received, and an output of the syntactic analysis unit, and for the content of the extracted portion related to the specification, performs a predetermined processing process along the format of the specification, And a text shaping means for outputting.

[Procedure Amendment 2]

[Document name to be amended] Statement

[Correction target item name] 0008

[Correction method] Change

[Correction content]

[0008]

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENT A preferred embodiment of a specification extracting device according to the present invention will be described in detail below with reference to the accompanying drawings. First, the present invention has a first feature that the source code (function) of the program, which has been conventionally stored in another file, and the specification are integrated and stored in one file. Since the specifications are required when actually using the program (system), it is necessary to provide a means for extracting only the parts related to the specifications from the file and supplying them to users. It has a second feature. The specific configuration is as follows.

[Procedure 3]

[Document name to be amended] Statement

[Correction target item name] 0009

[Correction method] Change

[Correction content]

FIG. 1 shows a first embodiment of a specification extracting device according to the present invention.
An example is shown. As shown in the figure, in this example, the source code and the specifications are stored in the storage device 1 as one file (input file). Then, a specific example thereof is shown in FIG. That is, the comment text that is the basis of the specification is
Along with the titles such as "TION" and "STRUCTURES", the explanation about the contents is described between " / * " and "* /", and the source code is described in C language after "Include files". As a result, one file is created. Then, this input file is sent to the specification extracting device 2.

[Procedure amendment 4]

[Document name to be amended] Statement

[Correction target item name] 0010

[Correction method] Change

[Correction content]

[0010] The specification extracting unit 2 is provided with a syntax analyzer 3 and text formatting unit 4, the syntax analyzing unit 3, from the input file, to extract described required specifications it is, also, the sentence shaping unit 4 performs predetermined processing together data extracted by the syntax analysis unit 3 into a standard format specifications, adapted to output, specifically Has the following functions.

[Procedure Amendment 5]

[Document name to be amended] Statement

[Correction target item name] 0011

[Correction method] Change

[Correction content]

[0011] In other words, the syntax analysis unit 3, first, is adapted to locate the comment statement that the body of the specification from the input file. Specifically, in the case of the input file for the C language, the area between "/ *" and "* /" is the comment area, so that "/ *" and "* /"
Are detected, and the contents ((a) in the figure) described in between are detected. Then, from the extracted sentences, words that become the items of the specifications, such as "DESCRIPT far N" or "S
Further, "TRUCTURES" and the like are extracted. The word is stored in the keyword file 5 linked to the syntax analysis unit 3.

[Procedure Amendment 6]

[Document name to be amended] Statement

[Correction target item name] 0013

[Correction method] Change

[Correction content]

Meanwhile, the sentence shaping unit 4, with respect to those extracted by <br/> syntax analyzer 3 in the manner described above, the sentence shaping mechanism included in the UNIX online manual mechanism (e.g. nroff etc.) Formatting command (".n
f ”,“ .br ”,“ .in ”...) Other various commands (“ owl ”,“ .SH ”...) and the like are added appropriately in accordance with the standard format of the online manual, and then output. .. The file to which the various commands are added in this way becomes the output file 6, and an example thereof is shown in FIG.

[Procedure Amendment 7]

[Document name to be amended] Statement

[Name of item to be corrected] 0037

[Correction method] Change

[Correction content]

In each of the above-mentioned embodiments, the UNI
Although an example in which X is used and the specification is provided online is explained, the present invention is not limited to this, and the specification can be stored by storing the output file in an electronic storage medium such as an FD. It may be provided, and the language used is not limited to UNIX, and any other language can be used.

[Procedure Amendment 8]

[Document name to be amended] Statement

[Compensation target item name] Explanation of sign

[Correction method] Change

[Correction content]

[Reference Numerals] 1 storage device 2 specification extracting unit 3 syntax analyzer 4 sentence shaping unit 6 output file 7 online manual mechanism unit 10 input unit 11 Editor 12,20 difference detector 13 display

[Procedure Amendment 9]

[Document name to be corrected] Drawing

[Name of item to be corrected] Figure 5

[Correction method] Change

[Correction content]

[Figure 5]

Front Page Continuation (72) Inventor Koji Tsunono 10 Oenron Co., Ltd., Hanazono Todocho, Ukyo-ku, Kyoto City, Kyoto Prefecture (72) Inventor Takashi Suzuki 47 Yotsuka-cho, Minami-ku, Kyoto City, Kyoto Prefecture 405 Sanvoa Kyoto

Claims (3)

[Claims] 1. A syntax for receiving the contents of an input file in which a program and a specification document are integrally stored, parsing the given input file, and extracting a part related to the specification document. And a sentence shaping means for receiving the output of the syntax analyzing means, performing a predetermined processing process on the extracted contents related to the specifications so as to follow the format of the specifications, and outputting the text. Specification extraction device equipped with. 2. A means for performing a correction process on the input file, a storage means for storing the contents of the file before the correction, a content of the file before the correction stored in the storage means,
The specification extraction device according to claim 1 is operated as needed, provided with a difference detection unit that compares the contents of the files after correction and detects whether there is a difference, and based on the determination result of the difference detection unit. Function to
The specification extracting device according to claim 1, further comprising means having at least one function of issuing a predetermined warning to a corrector. 3. A means for performing a correction process on the input file, a storage means for storing the contents of the file before the correction, and a file before the correction and a file after the correction stored in the storage means. The specification extracting device according to claim 1 is operated, or means for returning to the re-correction state of the input file is provided in accordance with the means for comparing and specifying the corrected portion and the output of the means for specifying the corrected portion. The specification extracting device according to claim 1.