JPH0455938A - プログラム仕様書自動生成方式 - Google Patents

Abstract

(57)【要約】本公報は電子出願前の出願データであるた
め要約のデータは記録されません。

Description

【発明の詳細な説明】 〔概要〕 プログラムからコメント付の仕様書を自動生成するプロ
グラム仕様書自動生成方式に関し、プログラム中に記述
されたコメント情報を抽出しておき、自動生成する仕様
書に反映し、より分かり易い仕様書を自動生成すること
を目的とし、入力されたプログラムから構文解析時にコ
メント情報を行番号に対応づけて抽出するコメント抽出
部と、入力されたプログラムを構文解析して行番号を付
加して住成した中間表現に対して、上記抽出したコメン
ト情報の行番号をもとに当該コメント情報を付加するコ
メント付加部とを備え、このコメント情報を付加した中
間表現をもとにコメント付の仕様書を生成するように構
成する。

〔産業上の利用分野〕

本発明は、プログラムからコメント付の仕様書を自動生
成するプログラム仕様書自動性成方式に関するものであ
る。銀行システムのような膨大な既存のプログラムの保
守作業を容易にするために、仕様書を電子的に管理し、
参照検索を容易にすることが要求されている。既存のプ
ログラムの仕様書の多くは手書きであり、電子的に管理
できる仕様書を作るために、プログラムから仕様情報を
抽出して仕様書を自動生成することが望まれている。

〔従来の技術〕

従来の仕様書生成方式は、プログラムの構文を解析する
際に直接関係のないコメント情報を削除していた。しか
し、コメントは、プログラムでは記述しない説明的な情
報が書かれており、プログラムを理解し、保守するため
に重要なものである。

〔発明が解決しようとする課題〕

従来の方式は、コメントを削除していたため、自動生成
される仕様書が人間に分かり難いものとなってしまうと
いう間即があった。

本発明は、プログラム中に記述されたコメント情報を抽
出しておき、自動生成する仕様書に反映し、より分かり
易い仕様書を自動生成することを目的としている。

〔課題を解決するための手段〕

第１図は、本発明の原理構成図を示す。

第１図において、プログラム１は、コメント付の仕様書
を生成する対象のプログラムである。

コメント抽出部３は、構文解析時にプログラム１からコ
メント情報５を抽出するものである。

中間表現６は、プログラム１を構文解析して生成した行
番号付の中間表現である。

コメント付加部７ば、中間表現６にコメント情報５を付
加したり、中間表現６から生成した仕様情報にコメント
情報５を付加したりするものである。

仕様書生成部８は、コメント付の中間表現６がら仕様書
を生成したり、中間表現６から行番号付の仕様情報を生
成したりするものである。

〔作用〕

本発明は、第１図に示すように、コメント抽出部３が入
力されたプログラムから構文解析時にコメント情報５を
行番号に対応づけて抽出し、コメント付加部７が入力さ
れたプログラムを構文解析して行番号を付加して生成し
た中間表現６に対して、抽出したコメント情報５０行番
号をもとに当該コメント情報５を付加し、このコメント
情報５を付加した中間表現６をもとに仕様書生成部８が
コメント付の仕様書を自動生成するようにしている。

また、コメント抽出部３が入力されたプログラムから構
文解析時にコメント情＠５を行番号に対応づけて抽出し
、仕様書生成部８が入力されたプログラムを構文解析し
て行番号を付加して住成した中間表現６をもとに行番号
付の仕様情報を住成し、コメント付加部７がコメント情
報５の行番号をもとに当該コメント情報５を仕様情報に
付加し、仕様書を自動生成するようにしている。

従って、プログラム中に記述されたコメント情報を行番
号に対応づけて抽出しておき、自動生成する仕様書に反
映することにより、より分かり易い仕様書を自動生成す
ることが可能となる。

〔実施例〕

まず、第１図から第９図を用いて本発明の１実施例の構
成および動作を順次詳細に説明する。

第１図において、構文解析部２は、プログラムｌを構文
解析し、行番号を付加した中間表現６を生成するもので
ある。

行番号カウンタ４は、構文解析中のプログラム１の行番
号をカウントするものである。

第２図は、本発明の１実施例構成図を示す。

第２図において、プログラム１は、ソースプログラムで
あって、例えばＣ０ＢＯＬ言語で記述した第５図プログ
ラム例である。

コメント抽出部３ば、構文解析部２から呼び出され、後
述する第３図フローチャートに従い、例えば第５図プロ
グラム例から第７図コメント情報５を抽出するものであ
る。

行番号カウンタ４は、コメント抽出部３がコメント情報
５をプログラム１から抽出するときに当該プログラム１
の行番号をカウントするものである。

中間表現ｆｉ＋　６−１は、プログラム１を構文解析し
て生成した行番号を付加した中間表現＋１）である。

例えば第５図プログラム例から第６図行番号を付加した
中間表現例である。

コメント付加部７は、中間表現１）　６−１に対して、
コメント情報５０行番号をもとに当該コメント情報５を
付加し、中間表現＋２１６−２を生成するものである０
例えば第６図中間表現例（中間表現（１））に、第７図
コメント情報例を付加し、第８図中間表現例（中間表現
（２））を生成するものである。

中間表現＋２１６−２は、中間表現＋１）６−１にコメ
ント情報５を付加した中間表現である。

仕様書生成部８ば、コメント情Ｈ５を付加した中間表現
（２１６−２から仕様書９を生成するものである０例え
ば第８図中間表現例（中間表現（２））から第９図仕様
書例を生成するものである。

仕様書９は、プログラム１から生成したコメント情報付
の仕様書であって、例えば第９図仕様書例である。

次に、第３図フローチャートに示す順序に従い、第２図
コメント抽出部３の処理を、第５図ないし第７図を用い
て詳細に説明する。

第３図において、■は、 行番号カウンター１ コメントフラグ　ｏｆｆ 記号フラグ　　　ｏｆｆ コメント−空文字列 記号−空文字列 に初期設定する。

Ｏは、プログラムを１文字読み込む。これは、例えば第
５図プログラム例の若い行番号からプログラムを１文字
読み込む。

■は、改行コードか否かを判別する。ＹＥＳの場合には
、［相］で行番号カウンタ４を１増やす（プログラム１
から読み込んだ１文字が改行であったので、次の行番号
に設定するために、行番号カウンタの内容を１増す）、
一方、Ｎｏの場合には、［相］を行う。

■は、コメントフラグがＯｎか否かを判別する。

ＹＥＳの場合（現在処理中の１文字がコメントの場合）
には、［相］ないし［相］を行う、ＮＯの場合（現在処
理中の１文字がコメントでない場合）には、［相］でこ
の１文字がコメント開始文字（例えば第５図コメント開
始文字“＊”）であるか否かを判別し、ＹＥＳのときに
Ｏで コメントに１文字追加 コメントフラグ　ｏｎ コメント行番号−行番号カウンタ（現在の行番号） とし、０以降を繰り返し行い、Ｎｏのときに＠以降を繰
り返し行う、一方、ＮＯの場合には、コメント抽出を行
うことなく、［相］ないし［相］で記号抽出を行う。

［相］は、コメント終了文字（例えばコメント終了文字
“車”）か否かを判別する。ＹＥＳの場合には、［相］
でコメント行番号とコメントを組にしてコメント情報と
して保存する。更に、 コメントフラグ　ｏｆｆ コメント−空文字列 に設定し、＠以降を繰り返し行う、一方、ＮＯの場合に
は、［相］でコメントに１文字、追加し、＠以降を繰り
返し行う。

以上の■ないし［相］の処理によって、プログラム１　
（例えば第５図プログラム例）からコメント情報５（例
えば第７図コメント情報例中の文１と記載した部分のコ
メント情Ｎ）を抽出する。

第３図において、■は、記号構成文字か否かを判別する
。ＹＥＳの場合には、＠で記号フラグがＯｎか否かを判
別し、ＹＥＳのときに［相］で記号に１文字追加して＠
以降を繰り返し行い、ＮＯのときに０で記号フラグをＯ
ｎ、記号に１文字追加して＠以降を繰り返し行う。一方
、Ｎｏの場合には、［相］で記号フラグがｏｎか否かを
判別し、ＹＥＳのときに［相］で記号を返しく例えば第
５図プログラム例中の０００２行の“ＥＶＡＬＵＡＴＥ
”をまとめて返し）で終了し、ＮＯのときに０以降を繰
り返し行う。

以上の■ないし［相］の処理によって、プログラム１　
（例えば第５図プログラム例）から第６図中間表現例を
生成するために必要な記号（例えば０００２行からＥＶ
ＡＬ［ＪＡＴＥ、　ＫＯＺ静ＯＣＫなど）を抽出する。

次に、第４図フローチャートに示す順序に従い、構文解
析処理を、第５図および第６図を用いて詳細に説明する
。

第４図において、■は、記号読み込みを行う。

これは、第３図［相］でプログラム中から抽出した記号
（例えば第５図プログラム例の０００２行の“ＥＶＡＬ
ＵＡＴＥ″、”ＫＯＺＡＮＯｆＪ″など）を読み込む。

■は、ファイルの終わりか否かを判別する。ＹＥＳの場
合には、終了する。ＮＯの場合には、■を行う。

＠は、文法にしたがって文をｍｔｂする。

［株］は、１文受理したか否かを判別する。ＹＥＳの場
合には、［相］で行番号を付与した中間表現を生成する
。これは、例えば１文である第５図プログラム例の全体
を受理した場合、第６図中間表現例を生成する。一方、
ＮＯの場合には、＠以降を繰り返し行う。

以上の■ないし＠の構文解析処理を、第３図［相］でプ
ログラム（例えば第５図プログラム例）から抽出した記
号について行い、中間表現（１）６−１（例えば第６図
中間表現例）を生成する。

次に、第７図コメント情報例をもとに、第６図中間表現
例（中間表現（１）））にコメント情報を付加し、第８
図中間表現例（中間表現（２））を生成するときの処理
を説明する。

（１）　　コメント情報を若い方から１つ取り出す。

これは、第７図コメント情報例から若い方の例えば行番
号０００１の“＊＊口座番号の入力チエツク＊＊′を取
り出す。

（２）中間表現＋１）をサーチし、近い行番号を見つけ
る。これは、（１）で取り出した“＊＊口座番号の入力
チエツクネ＊”の行番号０００１に近い行番号をここで
は第６図中間表現（１）の■の位置から行番号“０００
２”を見つける。

（３）見つけた行番号を消し、コメントを中間表現に付
加する。これは、（２）で見つけた第６図■の行番号０
００２を消し、ここにコメント“＊＊口座番号の入力チ
ェック傘＊”を付加し、第８図■に示すように中間表現
（２）にする。

以下同様に、第７図行番号０００５の“＊＊入力なしエ
ラー傘＊”、行番号００１Ｏの″車車その他のエラー＊
＊”について、第６図■、■をそれぞれ見つけ、第８図
■、■に示すようにコメントをそれぞれ付加した中間表
現（２）にする 第９図は、本発明に係るコメント付で出力した仕様書例
を示す、これは、第８図中間表現例（中間表現（２））
から仕様書を自動生成したものである。

ここで、第９図■、■、■のコメントは、第８図中間表
現例（中間表現（２））の■、■、■に対応している。

次に、第１０図ないし第１５図を用いて本発明の他の実
施例構成の動作を詳細に説明する。

第１０図は、本発明の他の実施例構成図を示す。

ここで、プログラムｌ、構文解析部２、コメント抽出部
３、行番号カウンタ４、コメント情報５、中間表現Ｅｌ
＋　６−１は、第２図構成と同じであるので、説明を省
略する。

第１０図において、仕様書生成部８−１は、中間表現（
１）６−１から行番号付の仕様情報９−１を生成するも
のである０例えば第６図中間表現（１）６−１から行番
号付の第１２図仕様情報例を生成するものである。

仕様情報９−１は、中間表現ｉｌｌ　６−１から生成し
た行番号付の仕様情報（例えば第１２図仕様情報例）で
ある。

コメント付加部７−１は、仕様情報９−１に、コメント
情報５中の行番号をもとに当該コメントを付加し、仕様
書（例えば第９図仕様書例）を生成するものである。

第１）図フローチャートに示す順序に従い、仕様書生成
部８−１の処理を説明する。

第１）図において、Ｏは、中間表現を１文読み込む、こ
れは、既述したように、例えば第５図プログラム例から
生成した第６図中間表現例（中間表現（１））から１文
を読み込む、ここでは、第６図中間表現例が１文である
ので、当該第６図中間表現例を全部読み込む。

＠は、中間表現ファイルが空か否かを判別する。

ＹＥＳの場合には、中間表現の全ての文の処理を終了し
たので、［相］で記録した補足生成部（例えば第９図中
の補足記述）を出力し、終了する。ＮＯの場合には、Ｏ
以降を行う。

＠は、辞書（第１３図）を用いて英字名を日本語名に置
き換える。例えば第６図英字名“ＫＯＺＡＮＯＣＫ”を
日本語名′口座番号判定コード”に置き換える。

＠は、文に変換ルール（第１４図）を適用する分岐文の
場合は個々の処理に含まれる文のも再帰的に変換ルール
を適用する。

■は、変換した文が登録パターン（第１５図）のパター
ン部とマツチする部分を含むかを調べる。

ＹＥＳの場合には、［相］以降を行う、Ｎｏの場合には
、０で変換結果を出力する（第１２図仕様情報を出力す
る）。

［相］は、マツチした部分を登録パターンの結果部で置
き換える。これは、■で変換した文が第１５図登録パタ
ーンのパターン部とマツチする部分を含むと判別された
ので、マツチした部分を登録パターンの結果部で置き換
える。

■は、登録パターンが既に使われているかを調べる。Ｙ
ＥＳの場合には、何もしなく、０を行う。

Ｎｏの場合には、＠で補足生成部（第１２図補足記述）
を記憶し、［株］を行う。

以上の処理について、第６図中間表現例について、第１
３図辞書によって日本語に置き換えた後、第１４図変換
ルール例および第１５図登録パターン例を適用すると、
第１２図仕様情報例が得られる。具体的に説明すると、 ■：第６図■に、第１４図■を適用し、第１２図■を生
成する。この例は、第１）図＠Ｎ○となり、第１５図登
録パターン例と比較しない。

■：第６図■に、第１４図■（２つ）を適用し、第１２
図■を生成する。この例も、第１）図［相］ＮＯ（第１
５図パターン部のマツチする部分を含まないので、＠Ｎ
ｏ））となり、第１５図登録パターン例と比較しない。

■：第６図■に、第１４図■（４つ）を通用し、第１２
図■を生成する。この例は、第１）図＠ＹＥＳとなり、
第１５図登録パターン例のパターン部で、エラーメツセ
ージ番号＝１　　（＝７１）、エラー項目番号＝口座番
号（＝？）、およびセクシッンＥＲＲ−ＳＥＣＴＩＯＮ
実行、にそれぞれマツチし、結果部で、“処理ｌ　（１
、口座番号）　”にそれぞれ置き換えて生成する。また
、補足生成部も生成する。

第１２図は、本発明に係る行番号付の仕様情報例を示す
。これは、既述したように、第６図行番号付の中間表現
ｆｉ＋から第１）図フローチャートに示す処理によって
生成した行番号付の仕様情報である。■ないし■は、第
６図■ないし■から生成したものである。

第１３図は、本発明に係る英字名日本語名対応辞書例を
示す。これは、第６図中間表現＋１）中の英字名を、日
本語に置き換える辞書である。

第１４図は、本発明に係る変換ルール例を示す。

これは、第６図中間表現（１）を第１２図仕様情報例に
変換するための変換ルールである０図中の■ないし■は
、第６図中間表現（１）の■ないし■に適用する変換ル
ールを示す。

第１５図は、本発明に係る登録パターン例を示す、これ
は、第１４図変換ルール例を中間表現（１）に適用し、
第１２図仕様情報例を生成するためのものである。

以上の処理によって生成した第１２図仕様情報例につい
て、第１０図コメント付加部７−１が第７図コメント情
報例の行番号をもとに、近い行番号の位置に当該コメン
ト情報例を埋め込んで付加し、第９図仕様書例を生成す
る。

〔発明の効果〕

以上説明したように、本発明によれば、プログラム中に
記述されたコメント情報を行番号に対応づけて抽出して
おき、自動生成する仕様書に付加する構成を採用してい
るため、より分かり易い仕様書をプログラムから自動生
成することができる。

【図面の簡単な説明】

第１図は本発明の原理構成図、第２図は本発明の１実施
例構成図、第３図は本発明に係るコメント抽出フローチ
ャート、第４図は本発明に係る構文解析フローチャート
、第５図はプログラム例、第６図は本発明に係る構文解
析によって生成した中間表現例、第７図は本発明に係る
保存したコメント情報例、第８図は本発明に係るコメン
トを付加した中間表現例、第９図は本発明に係るコメン
ト付で出力した仕様書例、第１０図は本発明の他の実施
例構成図、第１）図は本発明に係る仕様書生成部の処理
フローチャート、第１２図は本発明に係る行番号付の仕
様情報例、第１３図は本発明に係る英字名日本語名対応
辞書例、第１４図は本発明に係る変換ルール例、第１５
図は本発明に係る登録パターン例を示す。 図中、１ばプログラム、２は構文解析部、３はコメント
抽出部、４は行番号カウンタ、５はコメント情報、６は
中間表現、６−１は中間表現ｆｉｌ、６−２は中間表現
（２）、７．７−１はコメント付加部、８．８−１は仕
様書生成部、９は仕様書、９−１は仕様情報を表す。

Claims (2)

【特許請求の範囲】
1. （１）プログラムからコメント付の仕様書を自動生成す
   るプログラム仕様書自動生成方式において、入力された
   プログラムから構文解析時にコメント情報（５）を行番
   号に対応づけて抽出するコメント抽出部（３）と、 入力されたプログラムを構文解析して行番号を付加して
   生成した中間表現（６）に対して、上記抽出したコメン
   ト情報（５）の行番号をもとに当該コメント情報（５）
   を付加するコメント付加部（７）とを備え、このコメン
   ト情報（５）を付加した中間表現をもとにコメント付の
   仕様書（９）を生成するように構成したことを特徴とす
   るプログラム仕様書自動生成方式。
2. （２）プログラムからコメント付の仕様書を自動生成す
   るプログラム仕様書自動生成方式において、入力された
   プログラムから構文解析時にコメント情報（５）を行番
   号に対応づけて抽出するコメント抽出部（３）と、 入力されたプログラムを構文解析して行番号を付加して
   生成した中間表現（６）をもとに生成した行番号付の仕
   様情報に対して、上記抽出したコメント情報（５）の行
   番号をもとに当該コメント情報（５）を付加し、仕様書
   （９）を生成するコメント付加部（７）とを備え、 このコメント付加部（７）によって生成したコメント付
   の仕様書（９）を出力するように構成したことを特徴と
   するプログラム仕様書自動生成方式。