JPH0581004A - ドキユメント自動生成システム - Google Patents

Abstract

(57)【要約】 【目的】 複数のモジュールを含むソースファイルから
各々のモジュールに分けてドキュメントを自動生成する
ドキュメント自動生成システムを提供する。 【構成】 ドキュメント自動生成システムは、プログラ
ミング言語で記述されているソースファイルから、処理
フロー仕様書、テーブル定義仕様書、モジュール定義仕
様書の各ドキュメントファイルを自動生成する。このド
キュメント自動生成システムには、ドキュメント生成処
理部が備えられ、ソースファイルが複数モジュールから
構成されている場合に、各モジュール毎に処理フロー仕
様書ファイルを分割して、各ドキュメントファイルを作
成する。

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明は、ドキュメント自動生成
システムに関し、特に、ソフトウェア開発のために既存
のソースファイルからのドキュメントを自動的に生成す
るドキュメント自動生成システムにおいて、複数のモジ
ュールを含むソースファイルから各々のモジュール毎の
ファイルに分けてドキュメントを自動的に生成するドキ
ュメント自動生成システムに関するものである。

【０００２】

【従来の技術】特開平１−２３７７２６号公報にも記載
されているように、一般に、ソフトウエアの開発では、
開発すべきソフトウェアの具備すべき機能を定め、その
機能を実現するソフトウェアを段階的に詳細化して設計
を進め、最終的にプログラムを作成する方法が用いられ
る。ソフトウエアの開発の形態より着目すると、テーブ
ル定義仕様書、モジュール定義仕様書の各ドキュメント
が、まず作成され、続いて処理フロー仕様書を詳細化し
たのちにソースプログラムが作成される。

【０００３】また、予じめ部品化したプログラムを用い
てプログラム作成を行うソフトウァア開発の場合のよう
に、既存のプログラムを流用する開発形態では、テーブ
ル定義仕様書、モジュール定義仕様書などの基本的な各
ドキュメントが存在せず、ソースプログラムのみ存在す
る。このような場合には、ソースプログラムをもとに手
作業でドキュメントを作成して、後に続くソフトウェア
開発を進める。なお、格別に複雑でないシステムのプロ
グラム開発では、特にドキュメント類は一切作成しない
で、後に続くソフトウェア開発を進める場合もある。

【０００４】ところで、このようなプログラム流用の開
発形態でソフトウエア開発を行う場合、その開発工程を
さかのぼる際には、ドキュメントの作成は全て手作業に
依存しているわけではなく、例えば、前述の特開平１−
２３７７２６号公報に記載されているように、ソフトウ
ェア仕様書の自動生成システムを用いて、ジョブ制御文
を解析し、ジョブ単位のファイルからデ−タフロ−のド
キュメントなどを作成する場合もある。

【０００５】

【発明が解決しようとする課題】従来においては、前述
の特開平１−２３７７２６号公報に記載されているよう
に、ソースファイルからドキュメントを自動生成するド
キュメント自動生成システムが開発されているが、この
ようなドキュメント自動生成システムは、通常のソース
ファイルからドキュメントを自動生成するものであり、
単に、ソースファイル単位にその内容を出力するものと
なっている。そのため、ソースファイルが複数のモジュ
ールから構成されている場合、その出力結果は複数モジ
ュールの集まりのドキュメントとなってしまい、ソース
ファイルの各プログラムの実体に合せた各々のモジュー
ル毎のドキュメントとして管理することができず、実用
に耐えられないという問題点がある。

【０００６】特に、複数のモジュールから構成されてい
るソースファイルを、モジュール単位に分割したい場合
は、ドキュメント生成するドキュメント自動生成システ
ムを起動する前に、対象とするソースファイルを分割し
なければならず、操作が煩雑なものとなっているという
問題点がある。

【０００７】本発明は上記問題点を解決するためになさ
れものであり、本発明の目的は、ソフトウェア開発のた
めに既存のソースファイルからドキュメントを自動的に
生成するドキュメント自動生成システムにおいて、ソー
スファイルが複数モジュールより構成されている場合
に、処理フロー仕様書を各モジュール毎に分割して自動
作成できるドキュメント自動生成システムを提供するこ
とにある。

【０００８】

【課題を解決するための手段】上記の目的を達成するた
め、本発明のドキュメント自動生成システムは、プログ
ラミング言語で記述されているソースファイルから、処
理フロー仕様書、テーブル定義仕様書、モジュール定義
仕様書の各ドキュメントファイルを自動生成するドキュ
メント自動生成システムであって、ソースファイルが複
数モジュールから構成されている場合に、各モジュール
毎に処理フロー仕様書ファイルを分割して、ドキュメン
トファイルを作成するドキュメント生成処理部を備える
ことを特徴とする。

【０００９】また、ドキュメント生成処理部は、ソース
ファイルより処理フロー仕様書のドキュメントファイル
作成を行う場合、ソースファイルの処理フローを解析
し、処理フローにおいて他モジュールを呼び出す命令語
を検出した場合に、呼び出される他モジュールに対する
処理フロー仕様書のドキュメントファイルを格納する別
ファイルを生成し、他モジュールに対する処理フロー仕
様書のドキュメントファイルを作成して別ファイルに格
納した後、呼び出し側の処理フロー仕様書のドキュメン
トファイルを作成することを特徴とする。

【００１０】

【作用】本発明のドキュメント自動生成システムには、
ドキュメント生成処理部が備えられ、ドキュメント生成
処理部がプログラミング言語で記述されているソースフ
ァイルから、処理フロー仕様書、テーブル定義仕様書、
モジュール定義仕様書の各ドキュメントファイルを自動
生成する。ドキュメントファイルの自動生成は、ソース
ファイルが複数モジュールから構成されている場合に、
各モジュール毎に処理フロー仕様書ファイルを分割し
て、ドキュメントファイルを作成する。ドキュメント生
成処理部は、ソースファイルより処理フロー仕様書のド
キュメントファイル作成を行う場合、ソースファイルの
処理フローを解析し、処理フローにおいて他モジュール
を呼び出す命令語を検出した場合に、呼び出される他モ
ジュールに対する処理フロー仕様書のドキュメントファ
イルを格納する別ファイルを生成する。そして、他モジ
ュールに対する処理フロー仕様書のドキュメントファイ
ルを作成して別ファイルに格納した後、呼び出し側の処
理フロー仕様書のドキュメントファイルを作成する。

【００１１】このように、ソースファイルより処理フロ
ー仕様書のドキュメントファイルの作成を行うが、ソー
スファイル中に他に複数のモジュールが存在するとき、
例えば、他モジュールを呼び出す命令語を検出した場合
に、呼び出される他モジュール用の別の処理フロー仕様
書のドキュメントファイルを格納する格納用ファイルを
確保する。そして、当該モジュールに対する処理フロー
仕様書のドキュメントファイルを作成して、別に設けた
格納用ファイルに格納した後に、呼び出し側の処理フロ
ー仕様書のドキュメントファイルの作成を続行して、当
該ドキュメントファイルを格納する。これにより、複数
モジュールが含まれるソースファイルから自動的に複数
のモジュールの分かれたドキュメントファイルを生成す
ることができる。

【００１２】このドキュメント自動生成システムでは、
処理フロー定義ファイルの作成をモジュール単位に行っ
ているため、複数個のモジュールを含んだ規模の大きい
プログラムのソースファイルにおいても、ドキュメント
の保守作業および管理作業が容易となる。これにより、
システム保守において所定の品質が確保され、ソフトウ
ェア開発の生産性が向上する。

【００１３】

【実施例】以下、本発明の実施例を図面を参照して具体
的に説明する。図１は本発明の一実施例にかかるドキュ
メント自動生成システムを含むソフトウエア開発支援シ
ステムの全体構成を示すシステム構成図である。図１に
おいて、１は入力装置としてのキーボード、２はエディ
タ部、３は仕様書エディタ、４は処理フローエディタ、
５はデータ解析部、６はテキストファイル解析部、７は
内部データ解析部、８はドキュメント／ソース自動生成
部、９はソース生成部、１０はドキュメント生成部、１
２は内部データファイル、１３はドキュメントファイ
ル、１４はソースファイルである。また、１５は出力装
置である。

【００１４】キーボード１の入力により、エディタ部２
を起動して、エディタ部２の仕様書エディタ３および処
理フローエディタ３を使用する。エディタ部２の仕様書
エディタ３は、テーブル定義仕様書，モジュール定義仕
様書などの編集処理を行う。また、処理フローエディタ
４は、処理フロー仕様書の編集処理を行う。

【００１５】エディタ部２によって編集処理した仕様書
データは、一度、内部データ形式に書き換えられて、内
部データファイル１２に変換されて格納される。内部デ
ータファイル１２の内部データ形式のデータは、データ
解析部５の内部データ解析部６により解析され、テキス
ト形式データのドキュメントが生成されて、ドキュメン
トファイル１３として格納される。また、ドキュメント
ファイル１３のテキスト形式データのドキュメントを内
部データ形式のデータに変換する場合は、データ解析部
５のテキストファイル解析部６により、データ変換され
内部データ形式データに変換されて、内部データファイ
ル１２に戻される。

【００１６】ドキュメントファイル１３に格納されてい
るデータは、テキスト形式データとして格納されている
ため、そのまま既存のオペレーティングシステムが提供
しているデータ出力機能を使用して、出力装置１５への
出力が可能となっている。したがって、ドキュメントフ
ァイル１３に格納されているテキスト形式データのドキ
ュメントに対する修正は、エディタ部２を用いなくても
直接にドキュメントファイル１３にアクセスすることに
より修正を行うことができる。

【００１７】ドキュメント／ソース自動生成部８では、
ソース生成部９がドキュメントファイルからソースファ
イル１４を生成し、また、ドキュメント生成部１０は、
そのソースファイル１４からドキュメントファイル１３
を生成する処理を行う。

【００１８】図２はドキュメント生成部の処理の流れを
示す図である。ソースファイルからドキュメントを自動
生成する処理について説明すると、ドキュメントを生成
するための基となるソースファイル１４が与えられたと
き、ドキュメント自動生成部１０により、ドキュメント
ファイル１３が作成される。このドキュメント自動生成
処理では、ソースファイル１４におけるモジュール仕
様，テーブル仕様，ソースプログラムの処理フローに応
じて、テーブル定義仕様書ファイル１６、モジュール定
義仕様書ファイル１７、処理フロー仕様書ファイル１８
がそれぞれ別ファイルとして構成されたドキュメントフ
ァイル１３となる。

【００１９】図３は複数モジュールで構成されるソース
ファイルから処理フロー仕様書を自動生成する処理を説
明する図である。この処理はドキュメント／ソース自動
生成部８が処理を行う。図３を参照して複数モジュール
から構成するソースファイルの処理フロー仕様書の自動
生成処理を説明すると、ドキュメント自動生成を行う基
となるソースファイル１４において、プログラミング言
語で記述されているソースプログラムの処理フローが与
えられると、このプログラミング言語を解析をし、処理
フロー仕様書ファイル１８の作成を行う。図３に示すよ
うに、ソースファイル１４において、プログラムモジュ
ール３０の「ｓｕｂ１．ｓｙｓｌ」が与えられたとき、
まず、最初に「ＳＵＢ１：ＰＲＯＣ；」の構文３１によ
り、処理フロー仕様書ファイル１８において、「ｓｕｂ
１．ｈｃｐ」のモジュール処理フロー仕様書ファイル１
９を作成する。次に、ドキュメント生成の処理が進ん
で、ソースファイル１４において、プログラムモジュー
ル３０の「ＣＡＬＬ ＳＵＢ２；」の構文３２を認識し
た時点で、これに対するテキストデータのドキュメント
３３を生成すると共に、処理フロー仕様書として作成し
て登録する。そして、このとき、更に別に処理フロー仕
様書ファイルとして「ｓｕｂ２．ｈｃｐ」のモジュール
処理フロー仕様書ファイルファイル２０を作成する。

【００２０】ソースファイル１４のプログラムモジュー
ル３０の処理フローの解析においては、「ＣＡＬＬ Ｓ
ＵＢ２；」の構文３２の解析により、サブルーチンとな
っているモジュールの構文群３４の解析に移行している
ので、続いて行うドキュメント作成の処理は、処理フロ
ー仕様書ファイルの作成で「ｓｕｂ２．ｈｃｐ」のモジ
ュール処理フロー仕様書ファイル２０のファイル作成を
続行する。プログラムモジュール３０の構文群３４にお
ける解析で実行文の終了（構文ＥＮＤ）を解析すると、
ここで、既に作成されている「ｓｕｂ２．ｈｃｐ」のモ
ジュール処理フロー仕様書ファイル２０を先に格納す
る。そして同様に処理を続行し、処理フロー仕様書ファ
イルの作成で「ｓｕｂ１．ｈｃｐ」のモジュール処理フ
ロー仕様書ファイル１９に対応する実行文の終了構文３
４を解析した時点で、ここでのモジュール処理フロー仕
様書ファイル１９を格納する。

【００２１】なお、このように作成している処理フロー
仕様書ファイル１８における実行文が全て終了するまで
は、この処理フロー仕様書ファイル１８は格納されず、
ソースファイル１４の処理フローの解析において、他の
モジュールを呼び出していた場合は、モジュールの呼び
出し構文を解析した時に、モジュール処理フロー仕様書
ファイル１９，モジュール処理フロー仕様書ファイル２
０などの別の処理フロー仕様書ファイルを新たに作成し
ていく。このようにして、ドキュメントファイル、ソー
スファイルの相互変換を行う。

【００２２】

【発明の効果】以上説明したように、本発明のドキュメ
ント自動生成システムによれば、ソースファイルが複数
のモジュールが含まれている処理フローであっても、モ
ジュール単位に処理フロー仕様書ファイルを生成するた
め、各々のモジュールの管理が容易に行える。また、ソ
フトウェア開発において、テスト工程，運用において仕
様変更が発生した場合にも、自動生成した処理フロー仕
様書をエディタにより修正できる。そして、その後にソ
ース自動生成システムにより再びソースファイル化を行
うことにより、仕様変更が生じたモジュールの単体に対
して、保守が容易に行える。また、ドキュメントファイ
ルはテキストファイルであるため、万一、当該ドキュメ
ント自動生成システムのエディタがダウンしても、既存
のエディタで修正可能であり、保守が容易となる。

【図面の簡単な説明】

【図１】図１は本発明の一実施例にかかるドキュメント
自動生成システムを含むソフトウエア開発支援システム
の全体構成を示すシステム構成図、

【図２】図２はドキュメント生成部の処理の流れを示す
図、

【図３】図３は複数モジュールで構成されるソースファ
イルから処理フロー仕様書を自動生成する処理を説明す
る図である。

【符号の説明】

１ キーボード（入力装置） ２ エディタ部 ３ 仕様書エディタ ４ 処理フローエディタ ５ データ解析部 ６ 内部データ解析部 ７ テキストファイル解析部 ８ ドキュメント／ソース自動生成部 ９ ソース生成部 １０ ドキュメント生成部 １２ 内部データファイル １３ ドキュメントファイル １４ ソースファイル １５ 出力装置 １６ テーブル定義仕様書ファイル １７ モジュール定義仕様書ファイル １８ 処理フロー仕様書ファイル １９ モジュール処理フロー仕様書ファイル ２０ モジュール処理フロー仕様書ファイル

Claims (2)

【特許請求の範囲】
1. 【請求項１】 プログラミング言語で記述されているソ
   ースファイルから、処理フロー仕様書、テーブル定義仕
   様書、モジュール定義仕様書の各ドキュメントファイル
   を自動生成するドキュメント自動生成システムであっ
   て、ソースファイルが複数モジュールから構成されてい
   る場合に、各モジュール毎に処理フロー仕様ファイルを
   分割して、ドキュメントファイルを作成するドキュメン
   ト生成処理部を備えることを特徴とするドキュメント自
   動生成システム。
2. 【請求項２】 ドキュメント生成処理部は、ソースファ
   イルより処理フロー仕様書のドキュメントファイル作成
   を行う場合、ソースファイルの処理フローを解析し、処
   理フローにおいて他モジュールを呼び出す命令語を検出
   した場合に、呼び出される他モジュールに対する処理フ
   ロー仕様書のドキュメントファイルを格納する別ファイ
   ルを生成し、他モジュールに対する処理フロー仕様書の
   ドキュメントファイルを作成して別ファイルに格納した
   後、呼び出し側の処理フロー仕様書のドキュメントファ
   イルを作成することを特徴とする請求項１に記載のドキ
   ュメント自動生成システム。