JPH025132A - ドキュメント自動作成方式 - Google Patents

Abstract

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

Description

【発明の詳細な説明】 〔産業上の利用分野〕 本発明はプログラム保守用ドキュメントの自動作成方式
に関し、特に既存の原始プログラムや翻訳リストから高
品質で信頼性の高いドキュメントを作成することが可能
な、ドキュメント自動作成方式に関する。

〔従来の技術〕

従来のこの種の方式では、例えば、「ソフトウェア構造
設計支援システム（ＡＤＤＳ）Ｊ（日立評論ｖｏ１．６
６（１９８４年）ｐ、１５−１．８）に記載されている
如く、ある一定の規則に従った情報を原始プログラム中
にコメントとして記述する方式となっていた。

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

上記従来技術は、原始プログラム中にある一定の規則に
従った情報をコメン１−として記述しなければならず、
従って、既存のプログラムで規則に従っていない原始プ
ログラムについては、適用できないという問題があった
。

また、機能追加による原始プログラムの変更時も、上述
の規則に従った他の情報の見直しが必要であり、プログ
ラムの規模によっては見直し作業が大変であるという問
題もあった。

本発明は上記事情に鑑みてなされたもので、その目的と
するところは、従来技術における上述の如き問題を解消
し、原始プログラム格納ファイルや翻訳リス１−格納フ
ァイルを入力にして、モジュールの関連情報をプログラ
ム単位に求め、これを基にモジュール名称と手続き名称
の関連を求めることにより、清書システムの入力となり
得る情報を作成するためのドキュメン１〜自動作成方式
を提供することにある。

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

本発明の」−北口的は、プログラム保守用ドキュメント
の作成方式において、既存の原始プログラムや翻訳リス
ト格納ファイルを入力として、他モジュールを呼出す命
令から呼出しモジュール名称と同時に、原始プログラム
の同要を記述した文を求め、主従関係をパラメータ化し
て、主モジュールについてはプログラム概要をパラメー
タに付加することにより、清書システムの入力パラメー
タを作成することを特徴とするドキュメン１〜自動作成
方式によって達成される。

〔作用〕 本発明に係るドキュメント自動作成方式においては、現
存する原始プログラムや翻訳リスミル格納ファイルを入
力にして、モジュールを呼出すための命令を持つステー
トメン１−を抽出し、この命令オペランドに定義しであ
るモジュール名称を求めて、原始プログラムや翻訳リス
トについているモジュール名称が呼出すモジュール名称
をすべて求め、これから、主従関係をパラメータ化する
。

これを、入力ファイルのモジュールについてすべて実行
し、求めたパラメータ群を集め、清書システムに入力す
ることにより、ドキュメント自動作成が可能になる。

〔実施例〕

以下、本発明の実施例を図面に基づいて詳細に説明する
。

第１図は本発明の処理を示す動作フローチャートであり
、図の破線で囲まれた範囲が、本発明の処理動作を示し
ている。また、第２図は、原始プログラムファイルに格
納されている原始プログラムの概要を示す図、第３図は
、後述する中間テーブルの構成を示す図、第４図は、清
書システムへの入力パラメータを示す図、第５図は、清
書システムにより作成されるモジュール関連図を示して
いる。以下、上記各図に基づいて、本発明の処理動作を
説明する。

ステップ０１では、原始プログラムファイル中の原始プ
ログラムについて、モジュール名を呼出す命令（例えば
、ＣＡＬＬ）ワードを含むテキストをすべて抽出する。

次に、モジュールの概要を定義するワード（例えば、Ｔ
ＩＴＬＥ）を含むテキストを抽出する。ここでは、第２
図における原始プログラム（、Ａ）、（Ｂ）、・・・・
に示す如き結果を得たものとする。

すべてのモジュールについて上述の抽出動作を行った後
、ステップ０２では、抽出したテキストを入力にして、
モジュールの主従関係を求め、これを、ステップ０３で
、第３図に示す如き中間テーブルの形に作成する。

第３図に示す中間テーブルを基に、ステップ０４では、
データのパラメータ化を行う。ここでは、上記データを
入力として、主モジユール名称をＮＡＭＥパラメータに
、従モジュール名称をＥＸＴＥＲＮＡＬパラメータに展
開する。また、モジュールの概要を定義したテキストは
、その内容をＮＡＭＥパラメータに付加するようにして
、第４図に示す如きパラメータ群を作成する。

上述の処理動作で作成されたパラメータ群を清書システ
ムに入力する（ステップ０５）ことにより、第５図に示
す如きモジュール関連図のドキュメン１へが作成される
。

上記実施例によれば、既存のプログラムで規則に従って
いない原始プロゲラｌ＼についても、モジュールの主従
関係を求め、前述の清書システムに入力するようにした
ので、既存の清書システムの機能を有効に利用しながら
、高信頼性を有するモジュール関連のドキュメントを作
成することができるという効果がある。

上記実施例においては、少数の原始プログラムを例に挙
げたが、本発明によれば、ソフトウェアのプログラムの
規模が増大し、モジュール間の関連が複雑になっても、
原始プログラムを入力して上記処理を行うことにより、
モジュールの主従関係がグローバルにわかると同時に、
高品質なドキュメントが自動的に作成される。更に、一
つのファイルに製品のすべての原始プログラムを格納し
て上記処理を行うことにより、製品全体のモジュール関
連がわかる、または、翻訳リスト格納ファイルを入力に
すれば、マクロ命令中のモジュール呼出しもわかる等の
付加的な効果もある。

〔発明の効果〕

以」〕、述べた如く、本発明によれば、プログラム保守
用ドキュメントの作成方式において、既存の原始プログ
ラムや翻訳リスト格納ファイルを入力として、他モジュ
ールを呼出す命令から呼出しモジュール名称と同時に、
原始プログラムの同要を記述した文を求め、主従関係を
パラメータ化して、主モジュールについてはプログラム
概要をパラメータに付加することにより、清書システム
の入力パラメータを作成するようにしたので、原始プロ
グラム格納ファイルや翻訳リスト格納ファイルを入力に
して、モジュールの関連情報をプログラム単位に求め、
これを基にモジュール名称と手続き名称の関連を求める
ことにより、清書システ１１の入力となり得る情報を作
成するためのトキュメン１〜自動作成方式を実現できる
という顕著な効果を奏するものである。

【図面の簡単な説明】

第１図は本発明の処理を示す動作フローチャート、第２
図は原始プログラムファイルに格納されている原始プロ
グラムの概要を示す図、第３図は中間テーブルの構成を
示す図、第４図は清書システムへの入力パラメータを示
す図、第５図は清書システムにより作成されるモジュー
ル関連図である。 ０１〜０５：処理ステップ、１：命令やモジュール概要
を示すワード、２：主モジユール名称、３：テキスト。 第 図 第 図 第 図 第 図 第 図

Claims (1)

【特許請求の範囲】
1. １、プログラム保守用ドキュメントの作成方式において
   、既存の原始プログラムや翻訳リスト格納ファイルを入
   力として、他モジュールを呼出す命令から呼出しモジュ
   ール名称と同時に、原始プログラムの同要を記述した文
   を求め、主従関係をパラメータ化して、主モジュールに
   ついてはプログラム概要をパラメータに付加することに
   より、清書システムの入力パラメータを作成することを
   特徴とするドキュメント自動作成方式。