JPH03139721A - プログラム・ドキュメント作成装置 - Google Patents

Abstract

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

Description

【発明の詳細な説明】 ［発明の目的］ （産業上の利用分野） 本発明はエディタを用いて作成されたプログラムのソー
スコードから、そのモジュール構造等をプログラム・ド
キュメント形式で判り易く提示出力することのできるプ
ログラム・ドキュメント作成装置に関する。

（従来の技術） 情報処理技術の発達に伴い、種々の情報処理プログラム
の開発が盛んに行われている。この種のプログラムは、
通常、計算機上でエディタを用いてソースコードとして
作成される。しかしソースコードは、−殻間にはプログ
ラミング言語そのもので記述される為、計算機にとって
は都合が良いが、人間にとってはその理解が非常に困難
である。この為、作成されたソースコードに対応するプ
ログラム・ドキュメントがない場合には人間による上記
ソースコードの理解が非常に困難であり、新たに機能を
追加したい、或いはメインテナンスを行う場合、ソース
コードの解析・理解に多大な労力が必要となる。換言す
ればドキュメントなしでプログラムのモジュール構造等
を容易に理解することは殆ど不可能に近い。

またソースコードに対応するプログラム・ドキュメント
が作成される場合であっても、一般にそのプログラム・
ドキュメントは成る時点での情報が記述される過ぎない
ことが多く、常に最新の情報（現時点でのソースコード
情報）を示しているとは限らない。特にプログラムの構
造等は、その開発や改良の過程で随時変更されることが
常である。これ故、プログラムの開発・改良の過程で、
そのモジュール構造等をタイムリーに確認・把握するこ
とができないと云う問題があった。特にソフトウェアの
規模が大掛かりとなり、そのモジュール数が増大してき
ている昨今、そのモジュール構造をタイムリーに適確に
把握することが非常に困難化してきている。

（発明が解決しようとする課題） このように従来にあっては計算機上でエディタを用いて
ソースコードを作成していく際、作成したソースコード
から直接的にプログラムのモジュール構造を理解するこ
とが困難であり、ドキュメントを用いるにしてもその情
報をタイムリーに把握することが非常に困難である。こ
れ故、その開発・改良を適切に、効率的に行うことが非
常に困難であった。

本発明はこのような事情を考慮してなされたもので、そ
の目的とするところは、エディタを用いて作成されるソ
ースコードからプログラムのモジュール構造等の情報を
、必要な時点で容易に理解することを可能とし、プログ
ラムの開発・改良を容易化することのできるプログラム
・ドキュメント作成装置を提供することにある。

［発明の構成〕 （課題を解決するための手段） 本発明に係るプログラム・ドキュメント作成装置は、 エディタを用いて作成されたソースコードからプログラ
ムを構成するモジュールの親子関連を示すモジュール関
連情報を直接的に作成する手段を備え、例えばユーザ定
義された表示形式に従って前記モジュール関連情報をド
キュメントとして展開して前記プログラムのモジュール
構造を示す情報を出力するようにしたことを特徴とする
ものである。

また上記プログラム中の共通データを示すデータ定義情
報を直接的に作成する手段を備え、定義された表示形式
に従って前記デー゛夕定義情報をドキュメントとして展
開して前記プログラムのデータ定義情報を出力するよう
にしたことを特徴とするものである。

（作　用） 本発明によれば、エディタを用いてプログラムを開発・
改良していく過程において、作成されたソースコードか
ら直接的にそのプログラムを構成するモジュールの親子
関係を示すモジュール関連情報や、そのプログラム中の
共通データを示すデータ定義情報が作成される。そして
モジュール構造情報の参照要求やデータの参照要求が与
えられた場合、予め定義されたドキュメント表示形式で
上記モジュール関連情報やデータ定義情報のドキュメン
ト出力がなされるので、常に最新の情報をドキュメント
形式で提示出力することが可能となる。

この結果、プログラミング言語で記述されるソースコー
ドをその都度解析することなく、ソースコードに示され
るモジュール関連情報やデータ定義情報を必要な時点で
ドキュメント出力し、これを参照してモジュール構造等
を把握することが可能となるので、プログラムの開発・
改良を効果的に進めていくことが可能となる。

（実施例） 以下、図面を参照して本発明の一実施例に係るプログラ
ム・ドキュメント作成装置について説明する。

第１図は計算機システム上に実現される実施例装置の概
略構成図で、■はエディタを用いて作成されたソースコ
ードを格納するソースコード情報記憶部である。

キーボード等の入力部２．ＣＲＴデイスプレィ等の表示
部３．プリンタ等の出力部４を備えた制御部５は、上記
入力部２からの指示に従って前記ソースコード情報記憶
部１に格納されたソースコードに示される複数のモジュ
ール間の親子関係を表現するモジュール関連情報や、上
記ソースコード中の種々のデータ定義情報を、前記表示
部３または出力部４を用いてドキュメント形式で提示出
力する為の処理制御を実行するものである。

しかしてデータ変換抽出部６は前記制御部５の制御を受
けて前記ソースコード情報記憶部１に格納されたソース
コードを読出し、そのソースコードを解析してソースコ
ード中に含まれる複数のモジュール間の親子関係を表現
するモジュール関連情報、および上記ソースコード中に
含まれる種々のデータに関するデータ定義情報をそれぞ
れ抽出する。

上記モジュール関連情報を抽出する為のソースコードの
解析は、例えばプログラムを構成している複数のモジュ
ールをそれぞれ抽出し、これらのモジュール間の関連性
を調べていくことによりなされる。また前記データ定義
情報を抽出する為のソースコードの解析は、例えばソー
スコード中に出現するデータを順次抽出し、これらの各
データを順次定義付けしていくことにより行われる。

前記データ変換抽出部６はこのようにして抽出した前記
モジュール関連情報およびデータ定義情報を磁気ディス
ク装置等からなる外部記憶装置７に格納し、モジュール
関連情報テーブル７ａおよびデータ定義情報テーブル７
ｂをそれぞれ作成する。

尚、これらのモジュール関連情報テーブル７ａおよびデ
ータ定義情報テーブル７ｂの作成は、作業者がその情報
を必要とした時点で前記入力部２がらの指示に従って行
われる。またその指示情報に従い、モジュール関連情報
テーブル７ａまたはデータ定義情報テーブル７ｂの一方
だけが作成される場合もある。

一方、このようなデータ変換抽出部６によるモジュール
関連情報テーブル７ａおよびデータ定義情報テーブル７
ｂの作成手順と並行して、前記制御部５は表示形式定義
部８を起動し、外部記憶装置９上に表示形式定義ファイ
ル９ａを作成する。この表示形式定義ファイル９ａの作
成は、前記入力部２を介して前述したモジュール関連情
報やデータ定義情報をドキュメントで出力する際、どの
ようなドキュメント形式でその出力を実行するかと云う
定義情報を入力することによってなされる。具体的には
、例えば前記モジュール関連情報をツリー構造としてド
キュメント出力することを定義したり、モジュール関連
情報を一覧表形式でドキュメント出力すること、更には
モジュール関連情報をテキストの形式でドキュメント出
力すること等が定義される。

しかして制御部５は入力部２からの指示に従ってモジュ
ール関連情報テーブル７ａおよびデータ定義情報テーブ
ル７ｂの作成がなされ、また表示形式定義ファイル９ａ
の作成がなされたとき、表示制御部１０を起動してモジ
ュール関連情報およびデータ定義情報のドキュメント出
力を実行させる。このドキュメント出力の実行は、作成
された表示形式定義ファイル９ａに示されるドキュメン
ト表現形式で前記モジュール関連情報またはデータ定義
情報を展開してそのドキュメントを作成し、これを前記
表示部３または出力部４を介して作業者に提示出力する
ことによりなされる。この結果、例えばモジュール関連
情報が第２図に示すようなツリー構造による表現形式で
ドキュメント出力されることになる。

尚、データ定義情報についても同様にして指定された表
示形式によるドキュメントとしてその情報の提示出力が
行われる。

かくしてこのようなプログラムのモジュール関連情報を
、作業者からの要求に従ってドキュメント出力する本装
置によれば、第２図に例示されるようにプログラムを構
築している複数のモジュール間の構造関係をツリー構造
表現によるドキュメントとして判り易く提示することが
できる。７しかも情報提示が要求された時点での情報を
タイムリーにドキュメント出力することができる。従っ
てエディタを用いたソースコードの開発・改良の過　０ 程において現在の最新情報を効果的に得、その情報を適
確に把握しながら上記プログラムの開発・改良を進めて
いくことが可能となる。しかも従来のように一々ソース
コードを分析処理することなく簡易に、且つ効果的に必
要な情報を得ることができるので、プログラムの開発・
改良を効果的に支援することが可能となる。

尚、本発明は上述した実施例に限定されるものではない
。例えばドキュメントの表示形式についてはモジュール
間の構造関係をネットワーク形式で表現することも可能
であり、またそのテーブル構造情報をそのままドキュメ
ント出力することも可能である。更にはソースコードの
分析の手法等についても従来より種々提唱されている分
析アルゴリズムを適宜採用して行えば良い。その他、本
発明はその要旨を逸脱しない範囲で種々変形して実施す
ることができる。

［発明の効果］ 以上説明したように本発明によれば、作業者臼らが一々
ソースコードを分析することなしに、１ 作業者が必要とした時点でソースコードに示される最新
のモジュール関連情報やデータ定義情報をドキュメント
の形式でタイムリーに判り易く提示出力することができ
るので、その情報内容理解を容易ならしめてプログラム
の開発・改良を効果的に支援することが可能となる等の
実用上多大なる効果が奏せられる。

【図面の簡単な説明】

第１図は本発明の一実施例に係るプログラム・ドキュメ
ント作成装置の概略構成図、第２図は実施例装置にて作
成されてドキュメント出力されるモジュール関連情報の
例を示す図である。 １・・・記憶装置（ソースコード情報）　　２・・・入
力部、３・・・表示部、４・・・出力部、５・・・制御
部、６・・・データ変換抽出部、７・・・外部記憶装置
（モジュール関連情報テーブル、データ定義情報テーブ
ル）、８・・・表示形式定義部、９・・・外部記憶装置
（表示形式定義ファイル）、１０・・・表示制御部。

Claims (2)

【特許請求の範囲】
1. （１）エディタを用いて作成されたソースコードからプ
   ログラムを構成するモジュールの親子関連を示すモジュ
   ール関連情報を作成する手段と、ドキュメントの表示形
   式を定義する手段と、この定義された表示形式で前記モ
   ジュール関連情報を展開して前記プログラムのモジュー
   ル構造を示す情報をドキュメント出力する手段とを具備
   したことを特徴とするプログラム・ドキュメント作成装
   置。
2. （２）エディタを用いて作成されたソースコードからプ
   ログラム中の共通データを示すデータ定義情報を作成す
   る手段と、ドキュメントの表示形式を定義する手段と、
   この定義された表示形式で前記データ定義情報を展開し
   て前記プログラムのデータ定義情報をドキュメント出力
   する手段とを具備したことを特徴とするプログラム・ド
   キュメント作成装置。