WO2000050988A1

WO2000050988A1 - Apparatus for preparing program specifications, method for preparing program specifications, and recording medium on which program for preparing program specifications is recorded

Info

Publication number: WO2000050988A1
Application number: PCT/JP1999/000849
Authority: WO
Inventors: Koji Sasaki
Original assignee: Fujitsu Ltd
Current assignee: Fujitsu Ltd
Priority date: 1999-02-24
Filing date: 1999-02-24
Publication date: 2000-08-31
Anticipated expiration: 2001-08-24
Also published as: JP3886726B2

Description

明細書プログラム仕様書作成装置及びプログラム仕様書作成方法並びにプログラム仕様書作成プログラムを記録した記録媒体

技術分野

本発明は、リエンジニアリング，リバースエンジニアリング分野において、ソースプログラムに挿入されたコメントからプロダラム仕様書を作成する技術に関し、特に、プログラム仕様書の作成効率を向上させる技術に関する。

背景技術

従来から、ソースプログラムには、一般的に、プログラムの処理内容等を記述したコメントが挿入される。コメントとしては、ファイルに関するコメント，シンボルに関するコメントがある。ここで、「シンボル」とは、例えば、ソースプログラムが C + +言語で記述されている場合には、クラス，メンバ関数，外部変数等のように、 1つの特性を共通して持っているような要素の集合体をいう。そして、ファイルに関するコメントはファイルの先頭に、また、シンボルに関するコメントはシンボルの直前に挿入されるのが一般的である。

従って、ファイルの先頭部分では、ファイルに関するコメントとシンボルに関するコメントとが隣接することとなり、次のような問題点があった。即ち、各コメントには、プログラム仕様書に対応したコメント項目（以下「項目」という）が含まれる。このため、各コメントに同一項目が含まれる場合、その項目はどちらのコメントに属するものであるかの判断が困難となり、項目が抽出できなかつたり又は重複して抽出されていた。このような不具合があるため、抽出された項目に基づいてプログヲム仕様書を作成しようとしても、項目をそのまま利用することができず、人手による修正作業が不可欠であった。

そこで、本発明は従来の問題点に鑑み、各項目が属するコメントを明確にすることで、項目の抽出精度を向上させ、プログラム仕様書の作成効率を向上させることを目的とする。発明の開示

上記目的達成のため、第 1の手段として、ソースプログラムに挿入された各種コメントを識別するセパレ一タを設定するセパレータ設定手段と、該セパレータ設定手段により設定されたセパレータ毎に、プログラム仕様書に対応するコメント項目の抽出キ一ヮ一ドを設定するキーヮ一ド設定手段と、前記セパレータ設定手段により設定されたセパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出手段と、該コメント範囲抽出手段により抽出された各コメントの範囲毎に、前記キーヮ一ド設定手段により設定された抽出キーヮードに基づいて、ソースプログラムからコメント項目を抽出するコメント項目抽出手段と、該コメント項目抽出手段により抽出されたコメント項目に基づいて、プログラム仕様書を生成するプロダラム仕様書生成手段と、を含んでプロダラム仕様書作成装置を構成したことを特徴とする。

かかる構成によれば、ソースプログラムに揷入されたコメントからプログラム仕様書を効率良く作成するには、次のようにすればよい。即ち、ソースプログラムを記述する際の作業として、コメント種別を識別するセパレータをソースプログラムに挿入する。そして、プログラム仕様書を作成するときに、セパレータ設定手段によりセパレータを設定すると、設定されたセパレ一タに基づいて各コメントの範囲が抽出される。一方、抽出された各コメントの範囲毎に、キーワード設定手段により設定された抽出キーヮ一ドに基づいてソースプログラムからコメント項目が抽出される。そして、抽出されたコメント項目に基づいてプログラム仕様書が生成される。

このとき、ファイルの先頭において、種別が異なるコメントが隣接していても、両者を識別するセパレータにより、夫々のコメント範囲が正確かつ確実に識別される。従って、従来のように、コメント項目が抽出されなかったり、また、コメント項目が重複して抽出されることが防止され、抽出されたコメント項目をそのまま利用してプログラム仕様書を作成することができる。もって、コメント項目の抽出精度が向上し、プログラム仕様書の作成効率を向上することができる。また、前記セパレータは、各種コメントの開始行と終了行を特定する構成としてもよい。

かかる構成によれば、各種コメントの開始行及び終了行は、セパレータにより確実に識別される。このため、コメント範囲の抽出精度が向上し、プログラム仕様書の作成効率をより向上することができる。

さらに、前記セパレータ設定手段は、少なくとも、ファイルに関するコメントとシンボルに関するコメントとを識別するセパレータを設定する構成としてもよい。

かかる構成によれば、ファイルの先頭における隣接したコメントの識別を確実に行うことができる。即ち、一般的に、ファイルの先頭部分には、ファイルに関するコメントとシンボルに関するコメントとが隣接して挿入されている。このため、少なくとも両者を識別するセパレ一タを設定するようにすれば、ファイルの先頭部分におけるコメントの範囲の抽出が確実に行われるようになる。

この他には、前記コメント範囲抽出手段は、前記セパレータ設定手段によりセパレータが設定されていないコメントに対しては、他のコメントのセパレ一タ又は実行文に基づいて、コメントの範囲を抽出する構成としてもよい。また、前記コメント範囲抽出手段は、フアイルの先頭部分において 2つのコメントが隣接して挿入され、かつ、前記セパレ一タ設定手段によりセパレータが設定されていないときには、前記 2つのコメントの間に挿入された実行文に基づいて、コメントの範囲を抽出する構成としてもよい。

力、かる構成によれば、種々のコメント記述方式に対応することができる。また、前記コメント項目抽出手段は、ソースプログラムを記述したプログラム言語に応じたコメント識別子を取り除いたコメント項目を抽出する構成としてもよい。

かかる構成によれば、プログラム仕様書を生成する際に、不要であるコメント識別子が取り除かれるので、見易いプロダラム仕様書を作成することができる。第 2の手段として、ソースプログラムに揷入された各種コメントを識別するセパレータを設定するセパレータ設定工程と、該セパレータ設定工程により設定されたセパレ一タ毎に、プログラム仕様書に対応するコメント項目の抽出キーヮードを設定するキーヮード設定工程と、前記セパレータ設定工程により設定された W セパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出工程と、該コメント範囲抽出工程により抽出された各コメントの範囲毎に、前記キ一ワード設定工程により設定された抽出キーワードに基づいて、ソースプログラムからコメント項目を抽出するコメント項目抽出工程と、該コメント項目抽出工程により抽出されたコメント項目に基づいて、プログラム仕様書を生成するプログラム仕様書生成工程と、を含んでプログラム仕様書作成方法を構成したことを特徴とする。

力、かる構成によれば、ソースプログラムに挿入されたコメントからプログラム仕様書を効率良く作成するには、次のようにすればよい。即ち、ソースプロダラムを記述する際の作業として、コメント種別を識別するセパレータをソースプログラムに挿入する。そして、プログラム仕様書を作成するときに、セパレータ設定工程によりセパレータを設定すると、設定されたセパレ一タに基づいて各コメントの範囲が抽出される。一方、抽出された各コメントの範囲毎に、キ一ワード設定工程により設定された抽出キ一ヮ一ドに基づいてソースプログラムからコメント項目が抽出される。そして、抽出されたコメント項目に基づいてプログラム仕様書が生成される。

このとき、ファイルの先頭において、種別が異なるコメントが隣接していても、両者を識別するセパレータにより、夫々のコメント範囲が正確かつ確実に識別される。従って、従来のように、コメント項目が抽出されなかったり、また、コメント項目が重複して抽出されることが防止され、抽出されたコメント項目をそのまま利用してプログラム仕様書を作成することができる。もって、コメント項目の抽出精度が向上し、プロダラム仕様書の作成効率を向上することができる。第 3の手段として、ソースプログラムに挿入された各種コメントを識別するセパレータを設定するセパレータ設定機能と、該セパレータ設定機能により設定されたセパレータ毎に、プログラム仕様書に対応するコメント項目の抽出キーヮードを設定するキーワード設定機能と、前記セパレータ設定機能により設定されたセパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出機能と、該コメント範囲抽出機能により抽出された各コメントの範囲毎に、前記キーワード設定機能により設定された抽出キ一ワードに基づいて、ソ —スプログラムからコメント項目を抽出するコメント項目抽出機能と、該コメント項目抽出機能により抽出されたコメント項目に基づいて、プログラム仕様書を生成するプログラム仕様書生成機能と、を実現するためのプロダラム仕様書作成プロダラムを記録媒体に記録した。

ここで、「記録媒体」とは、各種情報を確実に記録でき、かつ、必要に応じて確実に取り出し可能なものをいい、磁気テープ、磁気ディスク、磁気ドラム、 I Cカード、 C D— R OM等の可搬記録媒体が該当する。

かかる構成によれば、セパレータ設定機能，キ一ワード設定機能，コメント範囲抽出機能，コメント項目抽出機能及びプログラム仕様書生成機能を実現するためのプログラム仕様書作成プログラムが記録媒体に記録される。従って、かかる記録媒体があれば、一般的な電子計算機を利用して、本発明に係るプログラム仕様書作成装置を容易に構築することができる。図面の簡単な説明

図 1は、本発明に係る仕様書作成装置の全体構成図である。

図 2は、処理対象となるソースプログラムの第 1例を示す図である。

図 3は、処理対象となるソースプログラムの第 2例を示す図である。

図 4は、処理対象となるソースプログラムの第 3例を示す図である。

図 5は、処理対象となるソースプログラムの第 4例を示す図である。

図 6は、生成されるプログラム仕様書の一例を示す図である。

図 7は、仕様書作成手順の流れを示すフローチヤ一トである。

図 8は、抽出キーヮードの設定画面の一例を示す図である。

図 9は、抽出キーヮードの設定画面の一例を示す図である。

図 10は、設定された抽出キーワードを示し、（A) はファイルに関するコメント情報、（B ) はクラスに関するコメント情報を示す。

図 11は、コメントを抽出するメインルーチンのフローチヤ一トである。

図 12は、ファイルに関するコメントを抽出するサブルーチンのフロ一チヤ一トである。

図 13は、シンボルに関するコメントを抽出するサブルーチンのフローチヤ一トである。

図 14は、ファイルに関するコメントの抽出範囲を求めるサブルーチンのフロ一チヤ一トである。

図 15は、シンボルに関するコメントの抽出範囲を求めるサブルーチンのフローチヤ一トである。

図 16は、仕様書に必要なコメント項目を抽出するサブルーチンのフローチヤ一トである。発明を実施するための最良の形態

本発明をより詳細に説述するために、添付の図面に従ってこれを説明する。図 2〜図 5は、本発明に係るプログラム仕様書作成装置（以下「仕様書作成装置」という）の処理対象となるソースプログラムの一例を示す。これらのソースプログラムは、プログラム言語として C + +言語により記述され、そのコメントは、「/*」で始まり「*/」で終わる部分、及び、各行における「〃」以降の部分である。なお、ソースプログラムにおける各行の先頭に付された数字は、プログラムの行番号を表す。

図 2に示すソースプログラムの構成について説明すると、次のようになる。即ち、 1行目〜 6行目がファイルに関するコメント、 7行目〜 1 6行目がクラス

(シンボル）に関するコメント、 1 7行目以降がクラスの定義文である。また、ファイルに関するコメントとクラスに関するコメントには、夫々、コメントの開始及び終了を表すセパレータが設けられる。ファイルに関するコメントでは、 1 行目及び 6行目のコメント行に含まれる「************」がセノ、。レータとして機能し、クラスに関するコメントでは、 7行目及び 1 6行目のコメント行に含まれる「」がセパレータとして機能する。

また、図 3に示すソースプログラムは、クラスに関するコメントにセパレータが設けられていない例である。図 4に示すソースプログラムは、ファイル及びクラスに関するコメントにセパレータが設けられておらず、両コメント間にセパレータとして機能する実行文「#include く stdio. h〉」が揷入されている例である。図 5に示すソースプログラムは、クラスに関するコメントがない例である。図 1は、仕様書作成装置の全体構成を示す。

仕様書作成装置は、表示装置 1 0と、入力装置 2 0と、外部記憶装置 3 0と、演算装置 4 0と、印刷装置 6 0と、を含んで構成される。表示装置 1 0は、 C R T , L C D等のディスプレイにより構成され、ユーザに対する G U I (Graphics 1 User Interface) 機能を提供する。入力装置 2 0は、キーボード及びマウス等のポインティングデバイスにより構成され、 G U Iに対するデータ入力機能を提供する。外部記憶装置 3 0は、ハードディスク等により構成され、ソースプログラムの保存機能を提供する。演算装置 4 0は、少なくとも、中央処理装置（C P U) とメモリとを含んで構成され、メモリにロードされたプログラムにより仕様書作成装置全体の制御を行う。印刷装置 6 0は、プリンタ等により構成され、作成されたプログラム仕様書の印刷機能を提供する。

また、演算装置 4 0には、抽出キーワード設定部 4 2と、コメント範囲抽出部 4 4と、コメント項目抽出部 4 6と、仕様書生成部 4 8と、仕様書印刷部 5 0と、がプログラムにより実装される。

抽出キーヮード設定部 4 2では、表示装置 1 0及び入力装置 2 0と連携して G U Iが提供され、コメントの種別に対応した抽出キーワードが設定される。ここで、「コメントの種別」とは、例えば、ソースプログラムが C + +言語で記述されている場合、ファイルに関するコメント、クラスに関するコメント等の識別子をいう。なお、抽出キーワード設定部 4 2が、セパレータ設定手段，セパレータ設定工程，セパレータ設定機能，キーワード設定手段，キーワード設定工程及びキーヮード設定機能として作用する。

コメント範囲抽出部 4 4では、外部記憶装置 3 0からソースプログラムフアイル 3 2が読み込まれ、設定された抽出キーワードに基づいて、ファイル全体に亘るコメントの抽出範囲が抽出される。図 2に示すソースプログラムを例にとって説明すると、ファイルに関するコメントの範囲として 1行目〜 6行目、クラスに関するコメントの範囲として 7行目〜 1 6行目が抽出される。なお、抽出されるコメントの範囲は、ファイルの先頭部分だけではなく、それ以降のコメントも含まれることは言うまでもない。また、コメント範囲抽出部 4 4が、コメント範囲抽出手段，コメント範囲抽出工程及びコメント範囲抽出機能として作用する。コメント項目抽出部 4 6では、設定された抽出キーワードに基づいて、各コメントに含まれるコメント項目が抽出される。図 2に示すソースプログラムのファィルに関するコメントを例にとって説明すると、「1 .概要」という抽出キーヮードに基づいて「Carクラスの宣言」、「2 .作成者」という抽出キーワードに基づいて「佐々木孝次」が抽出される。なお、コメント項目抽出部 4 6力コメント項目抽出手段，コメント項目抽出工程及びコメント項目抽出機能として作用する。

仕様書生成部 4 8では、抽出されたコメント項目に基づいて、図 6に示すようなプログラム仕様書が生成される。なお、仕様書生成部 4 8が、プログラム仕様書生成手段，プログラム仕様書生成工程及びプログラム仕様書生成機能として作用する。

仕様書印刷部 5 0では、生成されたプログラム仕様書のデータが印刷装置 6 0 に送信され、印刷装置 6 0によりプログラム仕様書が印刷される。

次に、かかる構成からなる仕様書作成装置の作用について説明する。

図 7は、プログラム仕様書を作成する手順のフローチャートを示す。

ステップ 1 (図では「S 1」と略記する。以下同様）では、ソースプログラムからコメントを抽出するための抽出キーワードが設定される。即ち、「抽出キーワードの設定」コマンドを実行すると、抽出キ一ワード設定部 4 2が選択的に起動され、図 8及び図 9に示すような抽出キーワードの設定画面（以下「設定画面」とレ、う） 1 0 0が表示される。そして、この設定画面 1 0 0上で、コメントの種別毎に抽出キーワードが設定される。抽出キーワードとしては、コメントの開始及び終了を表すセパレ一タ情報とプロダラム仕様書と対応させる仕様書情報とがある。

抽出キーワードを設定する手順としては、先ず、種別選択部 1 0 2からコメントの種別を選択する。そして、追加ボタン 1 0 4，削除ボタン 1 0 6及び変更ボタン 1 0 8を適当に操作して、セパレータ及びコメント項目に関する抽出キーヮードを入力する。また、他のコメント種別に関する抽出キーワードを続けて設定する場合には、種別選択部 1 0 2から他のコメントの種別を選択し、同様な操作を繰り返せばよレ、。抽出キ一ワードの入力が完了したら、 O Kボタン 1 1 0を操作することで抽出キーワードが確定する。一方、抽出キーワードの設定を中止したい場合には、任意の時点でキャンセルボタン 1 1 2を押せば、抽出キーワードが直前の状態に戻る。

なお、図 8では、ファイル情報に関する抽出キーワードとして、セパレータ情報及び仕様書情報「1 .概要」，「2 .作成者」が設定された様子が示されている（図 9も同様）。そして、その結果として、図 1 0に示すような抽出キーヮードが設定される。

ステップ 2では、コメントの種別毎に、ソースプログラムからコメントが抽出される。即ち、「コメントの抽出」コマンドを実行すると、コメント範囲抽出部 4 4及びコメント項目抽出部 4 6が選択的に起動され、後述する図 1 1〜図 1 6 のフローチヤ一トに従ってコメントが抽出される。

ステップ 3では、抽出されたコメントに基づいて、図 6に示すようなプロダラム仕様書が生成される。即ち、「プログラム仕様書の作成」コマンドを実行すると、仕様書生成部 4 8が選択的に起動され、その機能によりプログラム仕様書が生成される。

ステップ 4では、生成されたプログラム仕様書が印刷装置 6 0から出力される。即ち、「プログラム仕様書の印刷」コマンドを実行すると、仕様書印刷部 5 0が選択的に起動され、印刷装置 6 0によりプログラム仕様書が印刷される。

なお、以上の手順では、プログラム仕様書の作成及び印刷は任意に選択できる構成であるが、例えば、コメントの抽出を行うと、プログラム仕様書の印刷まで自動的に行われるようにしてもよレ、。

図 1 1は、ソースプログラムからコメントを抽出する処理のメインルーチンを示す。

ステップ 1 0では、外部記憶装置 3 0からソースプログラムファイル 3 2が読み込まれ、ソースプログラム中のシンボル情報が抽出される。ここで、「シンポル情報」とは、シンボル定義文の行情報及びシンボルの種別情報をいう。図 2に示すソースプログラムを例にとって説明すると、 1 7行目にクラスの定義文があるため、行情報が「1 7行目」、種別情報が「クラス」となる。なお、抽出されたシンボル情報は、例えば、行情報をキーとして昇順に保持される。ステップ 1 1では、ファイルに関するコメントを抽出するサブルーチンがコールされる。抽出されたコメントは、例えば、コメントの種別，仕様書に対するコメント項目をキーとしてテーブル形式で保持される（以下同様）。

ステップ 1 2では、次のシンボル情報が読み込まれる。即ち、最初の処理においては 1番目のシンボル情報が読み込まれ、それ以降の処理においては 2番目， 3番目，のシンボル情報が読み込まれる。

ステップ 1 3では、シンボル情報をパラメータとして、シンボルに関するコメントを抽出するサブルーチンがコールされる。

ステップ 1 4では、シンボルに関するコメントの抽出が、ソースプログラムフアイル 3 2の終端まで行われたか否か、即ち、コメントの抽出が完了したか否かが判定される。そして、コメントの抽出が完了したならば処理を終了し（Y e s ) 、コメントの抽出が完了していなければステップ 1 2へと戻る（N o ) 。図 1 2は、ステップ 1 1においてコールされるサブルーチン、即ち、ファイルに関するコメントを抽出するサブルーチンを示す。

ステップ 2 0では、ファイルに関するコメントの抽出範囲を求めるサブル一チンがコールされる。

ステップ 2 1では、ステップ 2 0において求められたコメントの抽出範囲から、プログラム仕様書に対応するコメント項目を抽出するサブルーチンがコールされる。

図 1 3は、ステップ 1 3においてコールされるサブルーチン、即ち、シンボルに関するコメントを抽出するサブルーチンを示す。

ステップ 3 0では、シンボルに関するコメントの抽出範囲を求めるサブルーチンがコ一ルされる。

ステップ 3 1では、ステップ 3 0において求められたコメントの抽出範囲から、プログラム仕様書に対応するコメント項目を抽出するサブルーチンがコールされる。なお、ここでコールされるサブルーチンは、先のステップ 2 1でコールされるサブルーチンと同一である。

図 1 4は、ステップ 2 0でコールされるサブルーチン、即ち、ファイルに関するコメントの抽出範囲を求めるサブルーチンを示す。ステップ 4 0では、ソースプログラムの 1行目の内容が取り出される。

ステップ 4 1では、取り出された 1行目の内容が実行文であるか否かが判定される。ここで、「実行文」とは、コメント行以外の文をいい、例えば、ソースプログラムが C + +言語で記述されている場合、「#define」文等のプリプロセッサの処理対象文，変数の定義文，クラスの定義文等が該当する。そして、 1行目の内容が実行文であれば、ソースプログラム中にはファイルに関するコメントがないと判断し、ステップ 4 7へと進む（Y e s ) 。一方、 1行目の内容が実行文でなければ（即ち、コメント行）ステップ 4 2へと進む（N o ) 。

ステップ 4 2では、 1行目の内容がシンボルのセパレータであるか否かが判定される。ここで、シンボルのセパレ一タは、図 9に示す抽出キーワードの設定画面 1 0 0で設定されたものが基準となる（以下同様）。そして、シンボルのセパレ一タであれば、ソースプログラムの 1行目はシンボルに関するコメントであると判断できるので、ファイルに関するコメントがないと判断して、ステップ 4 7 へと進む（Y e s ) 。一方、シンボルのセパレータでなければ、ファイルに関するコメントの開始行であると判断し、ステップ 4 3へと進む（N o ) 。

ステップ 4 3では、次の行の内容（以下「行内容」という）が取り出される。ステップ 4 4では、行内容が実行文であるか否かが判定される。そして、行内容が実行文であれば、ファイルに関するコメントの終了を表すセパレータがない形式（図 4のソースプログラム参照）であり、前行でファイルに関するコメントが終了したと判断して、ステップ 4 7へと進む（Y e s ) 。一方、行内容が実行文でなければ、ファイルに関するコメントが続いていると判断して、ステップ 4 5へと進む（N o ) 。

ステップ 4 5では、行内容がファイルのセパレータであるか否かが判定される。そして、ファイルのセパレ一タであれば、ファイルに関するコメントの終了行であると判断して、ステップ 4 7へと進む（Y e s ) 。一方、ファイルのセパレータでなければ、ファイルに関するコメントが続いていると判断して、ステップ 4 6へと進む（N o ) 。

ステップ 4 6では、行内容がシンボルのセパレ一タであるか否かが判定される。そして、シンボルのセパレ一タであれば、前行でファイルに関するコメントが終了したと判断して、ステップ 4 7へと進む（Y e s ) 。一方、シンボルのセパレータでなければ、ファイルに関するコメントが続いていると判断して、ステップ

4 3へと戻る（N o ) 。ここで、このような判定を行っているのは、例えば、フアイルに関するコメントの終了を表すセパレータがない場合を考慮したものである。

ステップ 4 7では、ファイルに関するコメントの抽出範囲が算出される。なお、ステップ 4 1又はステップ 4 2でファイルに関するコメントがないと判断された場合には、ファイルに関するコメント行がない旨を表す情報、例えば、開始行及び終了行に「0」が設定される。

図 1 5は、ステップ 3 0でコールされるサブルーチン、即ち、シンボルに関するコメントの抽出範囲を求めるサブルーチンを示す。

ステップ 5 0では、シンボル定義行の 1行前の内容が取り出される。ここで、シンボル定義行は、ステップ 1 3でシンボルに関するサブルーチン（図 1 3参照）をコールしたときのパラメータ（シンボル情報）の内容に基づき特定される。例えば、図 2のソースプログラムの場合には、シンボル（クラス）の定義文が 1 7行目にあるため、 1 6行目の内容が取り出される。

ステップ 5 1では、シンボル定義行の 1行前の内容が実行文であるか否かが判定される。そして、シンボル定義文の 1行前の内容が実行文であれば、シンボルに関するコメントがないと判断して、ステップ 5 6へと進む（Y e s ) 。一方、シンボル定義文の 1行前の内容が実行文でなければ、ステップ 5 2へと進む（N o ) 。なお、図 5に示すように、シンボル定義文の直前のコメントがファイルのコメントである場合には、重複した範囲を抽出しないようにするため、ファイルに関するコメントの抽出範囲を参照することが望ましい。

ステップ 5 2では、シンボル定義文の 1行前の内容が他のセパレータ、即ち、ファイル及び他のシンボルのセパレータであるか否かが判定される。そして、他のセパレータであれば、シンボルに関するコメントがないと判断して、ステップ

5 6へと進む（Y e s ) 。一方、他のセパレータでなければ、シンボルに関するコメントの終了行であると判断して、ステップ 5 3へと進む（N o ) 。

ステップ 5 3では、前の行の内容が取り出される。即ち、ファイルの先頭に向かってファイル解析を行い、シンボルに関するコメントの開始行を探索する。ステップ 5 4では、行内容が実行文であるか否かが判定される。そして、行内容が実行文であれば、シンボルに関するコメントの開始を表すセパレータがない形式（図 3のソースプログラム参照）であり、次の行からシンボルに関するコメントが始まると判断して、ステップ 5 6へと進む（Y e s ) 。一方、行内容が実行文でなければ、シンボルに関するコメントが続いていると判断して、ステップ 5 5へと進む（N o ) 。

ステップ 5 5では、行内容が他のセパレ一タであるか否かが判定される。そして、行内容が他のセパレ一タであれば、シンボルに関するコメントの開始を表すセパレータがない形式（図 3のソースプログラム参照）であり、次の行からシンボルに関するコメントが始まると判断して、ステップ 5 6へと進む（Y e s ) 。一方、行内容が他のセパレ一タでなければ、シンボルに関するコメントが続いていると判断して、ステップ 5 3へと戻る（N o ) 。

ステップ 5 6では、ファイルに関するコメントの抽出範囲が算出される。なお、ステップ 5 1又はステップ 5 2でファイルに関するコメントがないと判断された場合には、ステップ 4 7と同様な情報が設定される。

図 1 6は、ステップ 2 1及びステップ 3 1でコールされるサブルーチン、即ち、プログラム仕様書に必要なコメント項目を抽出するサブルーチンを示す。

ステップ 6 0では、ファイル又はシンボルに関するコメント行の 1行目の内容が取り出される。ここで、取り出される内容は、コメント行を表すコメント識別子、例えば、図 2に示すソースプログラムのファイルに関するコメントでは、「/ 」 ¾_び「水/」をレヽた「*=N==M«M«I«M«M」力 S り出される。

ステップ 6 1では、コメント行の内容が仕様書情報であるか否かが判定される。そして、仕様書情報であればステップ 6 2へと進み（Y e s ) 、仕様書情報でなければステップ 6 4へと進む（N o ) 。

ステップ 6 2では、仕様書情報に応じたコメント項目を格納する配列の要素番号、ポインタ等が変更される。

ステップ 6 3では、次の行がコメント項目の抽出範囲であるか否かが判定される。そして、コメント項目の抽出範囲であればステップ 6 0へと戻り（Y e s ) 、コメント項目の抽出範囲でなければ処理を終了する（No) 。

ステップ 64では、コメント項目の格納先が設定済みであるか否かが判定される。即ち、ステップ 62の処理で格納先が変更（設定）されたか否かが判定される。このような判定を行うためには、格納先が未設定の場合には、格納先として「NULL」を設定しておけばよい。そして、格納先が設定済みであればステップ 6 5へと進み（Y e s) 、格納先が未設定であればステップ 63へと進む（No) 。ここで、格納先が未設定である場合の例としては、コメント行の 1行目を処理しているときであって、その行がセパレータである場合である。

ステップ 65では、コメント項目が所定の格納先に格納される。

以上説明した処理によれば、ソースプログラムに揷入されたコメントからプログラム仕様書を効率良く作成するには、ソースプログラムを記述する際に、コメント種別を識別するセパレータを揷入する。そして、プログラム仕様書を作成するときに、挿入したセパレータ情報を設定すると、そのセパレータ情報に基づいて各コメントの範囲が抽出される。このとき、ファイルの先頭において、フアイルに関するコメントとシンボルに関するコメントとが隣接していても、両者を識別するセパレータにより、その範囲が正確かつ確実に識別される。その後、抽出された範囲内において、各コメントに応じた夫々のコメント項目が抽出され、プ口グラム仕様書が生成される。

従って、ファイルの先頭におけるコメント種別の混同が防止でき、抽出されたコメント項目をそのまま用いてプログラム仕様書を作成することができる。このため、プログラム仕様書の作成効率が大幅に向上し、例えば、プログラム開発期間の短縮，開発コストの削減等を図ることができる。

なお、以上説明した仕様書作成装置では、プログラム言語として C + +言語により記述されたソースプログラムを処理対象としたが、他のプログラム言語、例えば、 BAS I C, COBOL, FORTRAN, J a v a等を処理対象としてあよい。

このような機能を実現するプログラムを、例えば、磁気テープ，磁気ディスク，磁気ドラム， I Cカード， CD— ROM等の記録媒体に記録しておけば、本発明に係るプロダラム仕様書作成プログラムを市場に流通させることができる。そして、かかる記録媒体を取得した者は、例えば、一般的な電子計算機を利用して、本発明に係るプロダラム仕様書作成装置を容易に構築することができる。産業上の利用可能性

以上説明したように、本発明に係るプログラム仕様書作成装置及びプログラム仕様書作成方法は、コメント項目の抽出精度が向上するので、極めて有用なものである。また、本発明に係るプログラム仕様書作成プログラムを記録した記録媒体は、一般的な電子計算機を利用してプログラム仕様書作成装置を容易に構築できるので、極めて有用なものである。

Claims

請求の範囲

1 - ソースプログラムに挿入された各種コメントを識別するセパレ一タを設定するセパレータ設定手段と、

該セパレータ設定手段により設定されたセパレータ毎に、プログラム仕様書に対応するコメント項目の抽出キーヮードを設定するキーヮード設定手段と、前記セパレータ設定手段により設定されたセパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出手段と、

該コメント範囲抽出手段により抽出された各コメントの範囲毎に、前記キーヮ一ド設定手段により設定された抽出キーワードに基づいて、ソースプログラムからコメント項目を抽出するコメント項目抽出手段と、

該コメント項目抽出手段により抽出されたコメント項目に基づいて、プロダラム仕様書を生成するプログラム仕様書生成手段と、

を含んで構成されたことを特徴とするプログラム仕様書作成装置。

2 . 前記セパレ一タは、各種コメントの開始行と終了行を特定する構成である請求の範囲第 1項記載のプログラム仕様書作成装置。

3 . 前記セパレータ設定手段は、少なくとも、ファイルに関するコメントとシンボルに関するコメントとを識別するセパレータを設定する構成である請求の範囲第 1項記載のプロダラム仕様書作成装置。

4 . 前記コメント範囲抽出手段は、前記セパレータ設定手段によりセパレータが設定されていないコメントに対しては、他のコメントのセパレータ又は実行文に基づいて、コメントの範囲を抽出する構成である請求の範囲第 1項記載のプログラム仕様書作成装置。

5 ·前記コメント範囲抽出手段は、ファイルの先頭部分において 2つのコメントが隣接して挿入され、かつ、前記セパレータ設定手段によりセパレータが設定されていないときには、前記 2つのコメントの間に挿入された実行文に基づいて、コメントの範囲を抽出する構成である請求の範囲第 1項記載のプログラム仕様書作成装置。

6 .前記コメント項目抽出手段は、ソースプログラムを記述したプログラム言語に応じたコメント識別子を取り除いたコメント項目を抽出する構成である請求の範囲第 1項記載のプロダラム仕様書作成装置。

7 . ソースプログラムに揷入された各種コメントを識別するセパレータを設定するセパレータ設定工程と、

該セパレータ設定工程により設定されたセパレータ毎に、プログラム仕様書に対応するコメント項目の抽出キーヮードを設定するキーヮ一ド設定工程と、前記セパレータ設定工程により設定されたセパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出工程と、

該コメント範囲抽出工程により抽出された各コメントの範囲毎に、前記キ一ヮード設定工程により設定された抽出キーワードに基づいて、ソースプログラムからコメント項目を抽出するコメント項目抽出工程と、

該コメント項目抽出工程により抽出されたコメント項目に基づいて、プロダラム仕様書を生成するプログラム仕様書生成工程と、

を含んで構成されたことを特徴とするプロダラム仕様書作成方法。

8 . ソースプログラムに挿入された各種コメントを識別するセパレータを設定するセパレータ設定機能と、

該セパレ一タ設定機能により設定されたセパレータ毎に、プログラム仕様書に対応するコメント項目の抽出キーヮードを設定するキーヮード設定機能と、前記セパレータ設定機能により設定されたセパレータに基づいて、ソースプログラムの各コメントの範囲を抽出するコメント範囲抽出機能と、

該コメント範囲抽出機能により抽出された各コメントの範囲毎に、前記キーヮ一ド設定機能により設定された抽出キーワードに基づいて、ソースプログラムからコメント項目を抽出するコメント項目抽出機能と、

該コメント項目抽出機能により抽出されたコメント項目に基づいて、プロダラム仕様書を生成するプログラム仕様書生成機能と、

を実現するためのプログラム仕様書作成プログラムを記録した記録媒体。