JPH06139061A - プログラム仕様書逆生成方法 - Google Patents

Abstract

(57)【要約】 【目的】 ソースプログラムを変更した場合にソースプ
ログラムとプログラム仕様書の一体化を容易に実現す
る。 【構成】 逆生成対象のソースプログラムの記述内容と
キーワードファイルに格納されたキーワードとを順次比
較し、ソースプログラム中のキーワードを抽出し、さら
にそのキーワードに対するオペランドを抽出し、さら
に、この抽出したキーワードおよびオペランドをワーク
シート上の項目識別情報で示される項目位置に配置し、
プログラム仕様書として出力する。

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明は、ソースプログラムから
プログラム仕様書を逆生成するプログラム仕様書逆生成
方法に関するものである。

【０００２】

【従来の技術】既に作成したソースプログラムに対し
て、処理内容の追加、削除等の変更を加えた場合、その
ソースプログラムの仕様書に変更内容を反映させておく
必要がある。

【０００３】そこで、従来においては、ソースプログラ
ムの仕様書に図７（ａ），（ｂ），（ｃ）に示すような
変更内容を記入する欄７０と変更の種別を記入する欄７
１を設け、変更内容に応じて、これらの欄７０，７１に
必要な情報を担当者が記入し、ソースプログラムとその
仕様書との一体化を図っている。

【０００４】ここで、例えば図７（ａ）の仕様書にあっ
ては、データ「ｕ１．締日」を「締日（ワーク）」に更
新したことを示している。

【０００５】しかし、この方法は作業者が手作業によっ
て仕様書を更新するものであるため、その更新作業を怠
った場合、または誤った内容を記入してしまった場合
は、ソースプログラムとの対応関係が崩れ、その後のソ
ースプログラムの保守管理に障害を来すという問題があ
った。

【０００６】そこで、図８および図９に示すように、ソ
ースプログラム８０中に処理内容のコメント欄８１，８
２，８３を設け、ここに記述された処理内容を抽出する
ことにより、図１０に示すようなモジュール一覧表１０
０、関数一覧表１０１、テーブル一覧表１０２、データ
型一覧表１０３を自動生成する方法がある。

【０００７】

【発明が解決しようとする課題】しかしながら、図８お
よび図９に示すようなコメント欄８１，８２，８３に記
述された処理内容を抽出する方法では、ソースプログラ
ム中に処理内容のコメントをソースプログラムの作成時
に予め記述しておく必要があるため、その作業が煩わし
いと同時に、ソースプログラム自体が大規模になってし
まい、保守管理が却って面倒になるという問題があっ
た。

【０００８】本発明の目的は、ソースプログラム中にコ
メント等を記述することなく、ソースプログラムの内容
を正確に反映した仕様書を自動生成することができるプ
ログラム仕様書逆生成方法を提供することである。

【０００９】

【課題を解決するための手段】上記目的を達成するため
に、本発明は、処理内容を示すキーワードとオペランド
に関し、少なくとも逆生成対象のソースプログラムに使
用されている各キーワード、該各キーワードに対するオ
ペランドの記述位置、各キーワードおよびオペランドが
プログラム仕様書を構成するワークシート上のどの項目
に対応するかを示す項目識別情報をキーワードファイル
に格納しておき、逆生成対象のソースプログラムの記述
内容と前記キーワードファイルに格納されたキーワード
とを順次比較し、ソースプログラム中のキーワードを抽
出し、さらにそのキーワードに対するオペランドを前記
オペランドの記述位置の情報から抽出し、この抽出した
キーワードおよびオペランドをワークシート上の前記項
目識別情報で示される項目位置に配置し、その配置した
キーワードおよびオペランドをワークシートのフォーマ
ットに従いプログラム仕様書として出力するようにした
ものである。

【００１０】

【作用】上記手段においては、まず、逆生成対象のソー
スプログラムの記述内容とキーワードファイルに格納さ
れたキーワードとを順次比較し、ソースプログラム中の
キーワードを抽出する。さらにそのキーワードに対する
オペランドをオペランドの記述位置の情報から抽出す
る。さらに、この抽出したキーワードおよびオペランド
をワークシート上の項目識別情報で示される項目位置に
配置し、その配置したキーワードおよびオペランドをワ
ークシートのフォーマットに従いプログラム仕様書とし
て出力する。

【００１１】従って、担当者を煩わすことなく、またソ
ースプログラム中にコメント等を記述することなく、ソ
ースプログラムの内容を正確に反映した仕様書を自動生
成することができる。

【００１２】

【実施例】以下、この発明を日本語ＣＯＢＯＬで開発し
たソースプログラムに適用した実施例について詳述す
る。

【００１３】図１は、本発明のプログラム仕様書逆生成
方法を実現するシステムの一実施例を示すブロック構成
図であり、中央処理装置１、逆生成対象のソースプログ
ラムを格納したソースファイル２を備え、さらにソース
プログラム中の処理内容を示すキーワードとオペランド
に関し、少なくとも逆生成対象のソースプログラムに使
用されている各キーワード、該各キーワードに対するオ
ペランドの記述位置、各キーワードおよびオペランドが
プログラム仕様書を構成するワークシート上のどの項目
に対応するかを示す項目識別情報を格納したキーワード
ファイル３を備えている。

【００１４】さらにまた、プログラム仕様書を構成する
ワークシートの出力形式に関する情報を格納した出力形
式ファイル４、編集作業に使用するワークファイル５、
逆生成した仕様書を印字出力する漢字プリンタ等のプリ
ンタ６を備えている。

【００１５】なお、この実施例においては、キーワード
ファイル３には、逆生成対象のソースプログラムを記述
しているプログラム言語に用意されている全てのキーワ
ードについて、そのオペランドの記述位置、各キーワー
ドおよびオペランドがプログラム仕様書を構成するワー
クシート上のどの項目に対応するかを示す項目識別情報
が格納されている。

【００１６】また、ソースファイル２、キーワードファ
イル３、出力形式ファイル４、ワークファイル５は、ハ
ードディスク内に設けられている。

【００１７】図２はソースファイル２に格納されている
ソースプログラム２０の一例を示すものであり、ここで
は日本語ＣＯＢＯＬで記述されたソースプログラムの一
例を示している。

【００１８】図２の例では、キーワード２１は、「項目
加工処理」２２と「読込み」２３と「転記」２４であ
り、またキーワード２１に対応したオペランド２５は
「Ｏ１−出力処理」２６と「Ｉ１」２７と「Ｏ１．商品
コード ＜−− Ｉ１．商品コード」２８である。

【００１９】図３は、キーワードファイル３の一例を示
すものであり、プログラム仕様書を構成するワークシー
トに対応したワークシート番号と、ソースプログラム２
０を記述したプログラム言語で使用されている全てのキ
ーワードと、キーワードがプログラム仕様書を構成する
ワークシートのどの項目に属するか明記したキーワード
項目ＩＤと、キーワードに対応したオペランドの記述位
置を示すオペランド位置の情報と、オペランドがプログ
ラム仕様書を構成するワークシートのどの項目に属する
か明記したオペランド項目ＩＤで構成されている。

【００２０】図２の例では、「Ｂ３１０」３１がワーク
シート番号であり、「項目加工処理」３２と「読込み」
３６と「転記」３７がキーワード２１であり、「Ｈ０
１」３３と「Ｃ０１」３８と「Ｃ０１」３９がキーワー
ド項目ＩＤ４４であり、「Ｂ」３４，「Ｂ」４０，
「Ｂ」４１がオペランド位置情報４５であり、「Ｈ０
２」３５と「Ｃ０２」４２と「Ｃ０２」４３がオペラン
ド項目ＩＤ４６である。

【００２１】図４は、プログラム仕様書を構成するワー
クシート５０の一例を示すものであるが、プログラム仕
様書は、少なくとも、（１）プログラムで使用するファ
イルの入出力関係を明記する処理構成定義、入出力レコ
ードを選択するための条件を明記するレコード選択条
件、データを編集する処理を明記する項目加工処理のワ
ークシート５１と、（２）プログラムが起動されたとき
最初に１回だけ実行する処理を記述した初期処理のワー
クシート５２と、（３）プログラムが起動されたとき最
後に１回だけ実行する処理を記述した終了処理のワーク
シート５３とから構成されている。このワークシート５
０のフォーマットは出力形式ファイル４に予め記憶され
ている。

【００２２】なお、ソースプログラム２０が入出力装置
としてディスプレイを使用している時は、エラーメッセ
ージ等を明記するメッセージ一覧と、キーボードに割り
当てた処理を明記するＰＦキーと、ディスプレイから入
力されたデータ又はディスプレイへ出力するデータを編
集する処理を明記した画面入出力処理のワークシート
と、ディスプレイから入力されたデータをチェックする
画面チェック処理を記述したワークシートも含まれる
が、ここでは説明を簡単にするために省略する。

【００２３】ここで、図４の項目加工処理のワークシー
ト５１には、ワークシート番号を記述する欄５４、仕様
書名称を記述する欄５５、作成者氏名，審査者氏名，承
認者氏名をそれぞれ記述する欄５６，５７，５８、日付
欄５９、頁欄６０、命令を記述する欄６１、命令に対す
る処理対象を記述する欄６２が設けられている。

【００２４】以下、図２のソースプログラム２０から仕
様書を逆生成する動作について図５のフローチャートを
参照して説明する。

【００２５】まず、ソースファイル２から逆生成対象の
ソースプログラム２０を中央処理装置１内に読み込む
（ステップ２００）。

【００２６】次に、ソースファイル２から読み込んだデ
ータが「ＥＯＦ」（ファイル終了コード）であるかどう
かを調べ（ステップ２０１）、「ＥＯＦ」でなければ、
読み込んだデータを「スペース」もしく
は「．」，「、」，「：」，「；」のような分離記号で
分割することにより、複数の意味のある単語に分割す
る。

【００２７】図２のソースプログラム２の例では、「項
目加工処理」２２と「Ｏ１−出力処理」２６とがその間
の「スペース」で分割される。同様に、「読込み」２３
と「Ｉ１」とが分割される。さらに、「転記」２４，
「Ｏ１」，「商品コード」，「＜−−」，「Ｉ１」，
「商品コード」が分割される。

【００２８】次に、単語化したデータとキーワードファ
イル３のキーワード２１とを順次比較し、ソースプログ
ラム２０中のキーワード２２，２３，２４を抽出する。
さらにそのキーワード２２，２３，２４に対するオペラ
ンド２５をオペランドの記述位置の情報３４，４０，４
１から抽出する（ステップ２０２）。

【００２９】この場合、オペランドの記述位置の情報を
使用するのは、オペランドをキーワードの前と後に記述
する形態があるためで、「Ａ」はオペランドの後にキー
ワードが記述されていることを示し、「Ｂ」はオペラン
ドの前にキーワードが記述されていることを示してい
る。

【００３０】図２のソースプログラム２０においては、
キーワードの後にオペランドが記述されているので、オ
ペランドの記述位置の情報は全て「Ｂ」となっている。

【００３１】ステップ２０２においては、「項目加工処
理」、「読込み」、「転記」というキーワード２２，２
３，２４を抽出したならば、オペランドの記述位置の情
報「Ｂ」に従い、これらキーワード２２，２３，２４の
後に記述されているオペランド２６，２７，２８を抽出
することになる。

【００３２】次に、このようにして抽出したキーワード
２２，２３，２４およびオペランド２６，２７，２８を
ワークシート５０上の項目ＩＤで示される項目欄に配置
する編集を行う（ステップ２０３）。

【００３３】すなわち、「項目加工処理」というキーワ
ード２２はその項目ＩＤ３３が「Ｈ０１」、「読込み」
というキーワード２３はその項目ＩＤ３８が「Ｃ０
１」、「転記」というキーワード２４はその項目ＩＤ３
９が「Ｃ０１」となっており、さらに「Ｏ１−出力処
理」というオペランド２６はその項目ＩＤ３５が「Ｈ０
２」、「Ｉ１」というオペランド２７はその項目ＩＤ４
２が「Ｃ０２」、「Ｏ１．商品コード＜−−Ｉ１．商品
コード」というオペランド２８はその項目ＩＤ４３が
「Ｃ０２」となっている。

【００３４】この項目ＩＤ「Ｈ０１」，「Ｈ０２」，
「Ｃ０１」，「Ｃ０２」は、図４のワークシート５０で
は、破線で示す項目欄に対応している。

【００３５】そこで、ステップ２０３の編集処理の結
果、各キーワード２２，２３，２４およびオペランド２
６，２７，２８は図６に示すように、それぞれの項目Ｉ
Ｄで指定された項目欄に配置される。この時、ワークシ
ート番号「Ｂ３１０」も欄５４に配置される。

【００３６】なお、ワークシート５０はワークシート番
号「Ｂ３１０」によって出力形式ファイル４から検索さ
れ、ステップ２０３の編集処理に使用される。

【００３７】また、日付、頁の各欄５９，６０はソース
プログラム２０の図示しない位置に記述されたものが転
記される。

【００３８】以上のようにして生成されたワークシート
５０は、ソースファイル２からＥＯＦが読み込まれた後
に、ステップ２０４の出力処理においてプリンタ６から
プログラム仕様書として印字出力される。

【００３９】このように本実施例においては、まず、逆
生成対象のソースプログラム２０の記述内容とキーワー
ドファイル３に格納されたキーワードとを順次比較し、
ソースプログラム２０中のキーワードを抽出する。さら
にそのキーワードに対するオペランドをオペランドの記
述位置の情報から抽出する。さらに、この抽出したキー
ワードおよびオペランドをワークシート５０上の項目Ｉ
Ｄ（識別情報）で示される項目欄に配置し、その配置し
たキーワードおよびオペランドをワークシート５０のフ
ォーマットに従いプログラム仕様書として出力するの
で、担当者を煩わすことなく、またソースプログラム２
０中にコメント等を記述することなく、ソースプログラ
ム２０の内容を正確に反映した仕様書を自動生成するこ
とができる。

【００４０】これによって、ソースプログラムに対して
追加、削除等の変更等を行っても、その変更内容を正確
に反映したプログラム仕様書が得られるので、ソースプ
ログラムの保守管理が極めて容易になる。

【００４１】

【発明の効果】以上のように本発明においては、処理内
容を示すキーワードとオペランドに関し、少なくとも逆
生成対象のソースプログラムに使用されている各キーワ
ード、該各キーワードに対するオペランドの記述位置、
各キーワードおよびオペランドがプログラム仕様書を構
成するワークシート上のどの項目に対応するかを示す項
目識別情報をそれぞれキーワードファイルに格納してお
き、逆生成対象のソースプログラムの記述内容と前記キ
ーワードファイルに格納されたキーワードとを順次比較
し、ソースプログラム中のキーワードを抽出し、さらに
そのキーワードに対するオペランドを前記オペランドの
記述位置の情報から抽出し、この抽出したキーワードお
よびオペランドをワークシート上の前記項目識別情報で
示される項目位置に配置し、その配置したキーワードお
よびオペランドをワークシートのフォーマットに従いプ
ログラム仕様書として出力するようにしたので、システ
ム開発担当者を煩わすことなく、またソースプログラム
中にコメント等を記述することなく、ソースプログラム
の内容を正確に反映した仕様書を自動生成することがで
きる。

【００４２】これによって、ソースプログラムに対して
追加、削除等の変更等を行っても、その変更内容を正確
に反映したプログラム仕様書が得られるので、システム
開発を行うシステムエンジニアにとってソースプログラ
ムを修正した際にソースプログラムとプログラム仕様書
の一体化を図ることに要していた多大な時間を削減し、
ソースプログラムの保守管理を極めて容易に実施できる
等の極めて有用な効果が得られる。

【図面の簡単な説明】

【図１】 本発明のプログラム仕様書逆生成方法を実現
するシステムの一実施例を示すブロック構成図である。

【図２】 逆生成対象のソースプログラムの一例を示す
説明図である。

【図３】 キーワードファイルの一例を示す説明図であ
る。

【図４】 プログラム仕様書を構成するワークシートの
一例を示す説明図である。

【図５】 ソースプログラムからプログラム仕様書を生
成出力するための手順を示すフローチャートである。

【図６】 プログラム仕様書の出力結果の一例を示す説
明図である。

【図７】 プログラム仕様書を手作業で更新する従来例
を示す説明図である。

【図８】 ソースプログラム中にコメントを入れたソー
スプログラムの一例を示す説明図である。

【図９】 図８の続きを示す説明図である。

【図１０】 図８のソースプログラムのコメントによっ
て生成されるプログラム仕様書の説明図である。

【符号の説明】

１…中央処理装置、２…ソースファイル、３…キーワー
ドファイル、４…出力形式ファイル、６…プリンタ、２
０…ソースプログラム、２１…キーワード、２５…オペ
ランド、４４…キーワード項目ＩＤ、４５…オペランド
位置情報、４６…オペランド項目ＩＤ、５０…ワークシ
ート。

Claims (1)

【特許請求の範囲】
1. 【請求項１】 処理内容を示すキーワードとオペランド
   に関し、少なくとも逆生成対象のソースプログラムに使
   用されている各キーワード、該各キーワードに対するオ
   ペランドの記述位置、各キーワードおよびオペランドが
   プログラム仕様書を構成するワークシート上のどの項目
   に対応するかを示す項目識別情報をキーワードファイル
   に格納しておき、逆生成対象のソースプログラムの記述
   内容と前記キーワードファイルに格納されたキーワード
   とを順次比較し、ソースプログラム中のキーワードを抽
   出し、さらにそのキーワードに対するオペランドを前記
   オペランドの記述位置の情報から抽出し、この抽出した
   キーワードおよびオペランドをワークシート上の前記項
   目識別情報で示される項目位置に配置し、その配置した
   キーワードおよびオペランドをワークシートのフォーマ
   ットに従いプログラム仕様書として出力することを特徴
   とするプログラム仕様書逆生成方法。