JPH0219925A - ドキュメント生成方式 - Google Patents

Abstract

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

Description

【発明の詳細な説明】 〔産業上の利用分野〕 本発明は、ソフトウェアの開発支援におけるドキュメン
ト生成に関する。特にソースプログラム記憶装置に格納
されているソースプログラムを解析し、ドキュメントを
生成する方式に関する。

〔概要〕

本発明はソフトウェア開発支援におけるドキュメント生
成方式において、 ソースプログラム識別名とソーステキストを組とする複
数のソースプログラムを記憶装置に格納しておき、この
格納されたソースプログラムを解析し、開発・保守作業
者にソフトウェアの正確なドキュメントを提供すること
により、 作業効率を向上させるようにしたものである。

〔従来技術〕

従来のドキュメント作成作業では、人間がソフトウェア
内容を理解し、ドキュメントを手作業で作成しでいた。

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

上述した従来のドキュメント作成作業では、ドキュメン
トの作成工数がかかるために、ソフトウェアの改造およ
び機能強化に伴うドキュメントの保守作業を同期をとっ
て行うことが困難であり、また手作業で作成するために
ドキュメントに記述される内容と出力形式の標準化が困
難であり、必要な情報が別の作業者に伝達されないなど
の問題点がある。

本発明は、上記問題点を解決し、開発・保守作業者にソ
フトウェアの正確な情報を提供し、作業の効率を向上さ
せることを目的とする。

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

本発明は、ドキュメントの生成を行うためのプログラム
解析処理、解析データの追加・置換・削除処理を含む処
理モードおよび処理対象を指定する処理指定装置と、こ
の処理指定装置によって、処理対象として指定されたソ
ースプログラムの識別名を格納するソースプログラム識
別名記憶装置と、ソースプログラム識別名とソーステキ
ストを組とする複数のソースプログラムを格納するソー
スプログラム記憶装置と、前記処理指定装置によりプロ
グラム解析処理が指定されたときに、前記ソースプログ
ラム識別名記憶装置に格納されたソースプログラム識別
名に従って、前記ソースプログラム記憶装置からソース
テキストを読み込み、予約語テーブルを参照し、語彙を
切り出し、構文のチェックを行い、ドキュメントの生成
時に参照するデータを抽出するプログラム解析装置と、
このプログラム解析装置が抽出した解析データを格納す
る解析データ記憶装置と、前記処理指定装置で解析デー
タの追加・置換・削除処理が指定されたときに、前記ソ
ースプログラム識別名記憶装置に格納されたソースプロ
グラム識別名に従って、前記解析データ記憶装置に格納
されている解析データを追加・置換・削除する解析デー
タ保守装置と、前記解析データ記憶装置から解析データ
を読み込み、解析データをもとにドキュメントを出力す
るドキュメント出力装置とを備えたことを特徴とする。

〔作用〕

処理指定装置がドキュメントの生成を行うためのプログ
ラム解析処理、解析データの追加・置換・削除処理を含
む処理モードおよび処理対象を指定し、ソースプログラ
ム識別名記憶装置がこの処理指定装置によって、処理対
象として指定されたソースプログラムの識別名を格納し
、ソースプログラム記憶装置がソースプログラム識別名
とソーステキストを組とする複数のソースプログラムを
格納する。

また、プログラム解析装置が処理指定装置によりプログ
ラム解析処理が指定されたときに、ソースプログラム識
別名記憶装置に格納されたソースプログラム識別名に従
って、ソースプログラム記憶装置からソーステキストを
読み込み、予約語テーブルを参照し、語彙を切り出し、
構文のチェックを行い、ドキュメントの生成時に、参照
するデータを抽出し、解析データ記憶装置に格納し、解
析データ保守装置が処理指定装置により解析データの追
加・置換・削除処理が指定されたときに、ソースプログ
ラム識別名記憶装置に格納されたソースプログラム識別
名に従って、解析データ記憶装置に格納されている解析
データを追加・置換・削除し、ドキュメント出力装置が
解析データ記憶装置から解析データを読み込み、解析デ
ータをもとにドキュメントを出力する。これにより作業
の効率を向上させることができる。

〔実施例〕

次に本発明実施例を図面に基づいて説明する。

第１図は本発明実施例の構成を示す図である。

本発明実施例は、ドキュメントの生成を行うためのプロ
グラム解析処理、解析データの追加・置換・削除処理を
含む処理モードおよび処理対象を指定する処理指定装置
１と、この処理指定装置１によって、処理対象として指
定されたソースプログラムの識別名を格納するソースプ
ログラム識別名記憶装置２と、ソースプログラム識別名
とソーステキストを組とする複数のソースプログラムを
格納するソースプログラム記憶装置３と、処理指定装置
１によりプログラム解析処理が指定されたときに、ソー
スプログラム識別名記憶装置２に格納されたソースプロ
グラム識別名に従って、ソースプログラム記憶装置３か
らソーステキストを読み込み、予約語テーブルを参照し
、講堂を切り出し、構文のチェックを行い、ドキュメン
トの生成時に参照するデータを抽出するプログラム解析
装置４と、このプログラム解析装置４が抽出した解析デ
ータを格納する解析データ記憶装置５と、処理指定装置
１て解析データの追加・置換・削除処理が指定されたと
きに、ソースプログラム識別名記憶装置２に格納された
ソースプログラム識別名に従って、解析データ記憶装置
５に格納されている解析データを追加・置換・削除する
解析データ保守装置６と、解析データ記憶装置５から解
析データを読み込み、解析データをもとにドキュメント
８を出力するドキュメント出力装置７とを備える。

このように構成された本発明実施例の動作について説明
する。処理指定装置１では、処理指定モード（プログラ
ム解析処理、解析データの追加・置換・削除処理）およ
び処理対象を指定する。プログラム解析処理が選択され
た場合には、プログラム解析装置４が起動される。解析
データの追加・置換・削除処理が選択された場合には、
解析データ保守装置６が起動される。また処理対象は、
ソースプログラム識別名記憶装置２に格納される。

プログラム解析装置４は、ソースプログラム識別名記憶
装置２に格納されたソースプログラム識別名に従って、
ソースプログラムを格納したソースプログラム記憶装置
３より、ソースプログラムを読みだし、解析データ記憶
装置５に解析データを出力する。

解析データ保守装置６は、ソースプログラム識別名記憶
装置２に格納されたソースプログラム識別名に従って、
解析データ記憶装置５に格納されている解析データを追
加・置換・削除する。

ドキュメント出力装置７は、解析データ記憶装置５に格
納されている解析データを参照し、ドキュメント８を出
力する。

第２図は、本実施例におけるソースプログラム識別名記
憶装置２の構成を示し、ソースプログラム識別名が格納
される。

第３図は、本実施例におけるソースプログラム記憶装置
３の構成を示し、複数個のソースプログラム記イ、＠単
位から構成され、そのソースプログラム記憶単位はソー
スプログラム識別名とソーステキストからなる。

第４図は、本実施例におけるプログラム解析装置４の構
成を示す。ソーステキスト読み取り部４１は、ソースプ
ログラム識別名記憶装置２に格納されたソースプログラ
ム識別名に従って、ソースプログラム記憶装置３より、
ソーステキストを読み込む。語堂切り出し部４２は、ソ
ーステキスト読み取り部４１で読み込んだソーステキス
トを、予約語テーブル４３を参照し講堂に分解する。構
文チェック部４４は、構文規則テーブル４５を用いて構
文のチェックを行う。解析データ抽出部４６は、解析デ
ータを解析データ記憶装置５に格納する。

第５図は、本実施例における解析データ記１．！装置５
の構成を示し複数の解析データ記憶単位からなる。解析
データ記憶単位はソースプログラム識別名と解析データ
の組からなる。解析データは以下のデータ種別と対応す
るデータの組からなっている。

データ種別： ■　プログラム情報（名称、ステップ数）■　データ情
報（宣言行、記述行、タイプ）■　命令情報（命令種別
、記述行、データ名）第６図は、本実施例における解析
データ保守装置６の構成を示す。処理指定装置１で解析
データの削除が指定された場合削除部６１が起動される
。

削除部６１は、ソースプログラム識別名記憶装置２に従
って解析データ記憶装置５に格納されている解析データ
を削除する。また、処理指定装置１で解析データの追加
・置換が指定された場合複写部６２が起動される。複写
部６２は、別の解析データ記憶装置５からソースプログ
ラム識別名記憶装置２に従って解析データを追加・置換
する。

第７図は、本実施例におけるドキュメント出力装置７の
構成を示す。ドキュメント出力装置７は、解析データ記
憶装置５に格納されている解析データをもとに、システ
ム設計書８１（ソフトウェア全体に関するドキュメント
）、プログラム設計書８２くプログラムに関するドキュ
メント）、改造・保守設計書８３（改造・保守に関する
ドキュメント）を作成する。

〔発明の効果〕

以上説明したように本発明によれば、ソースプログラム
記憶装置に格納されているソースプログラムを解析し、
開発・保守作業者にソフトウェアの正確なドキュメント
を提供することにより、作業の効率を向上させる効果が
ある。

【図面の簡単な説明】

第１図は本発明実施例の構成を示す図。 第２図は本発明実施例のソースプログラム識別名記憶装
置の構成を示す図。 第３図は本発明実施例のソースプログラム記憶装置の構
成を示す図。 第４図は本発明実施例のプログラム解析装置の構成を示
す図。 第５図は本発明実施例の解析データ記憶装置の構成を示
す図。 第６図は本発明実施例の解析データ保守装置の構成を示
す図。 第７図は本発明実施例のドキュメント出力装置の構成を
示す図。 １・・・処理指定装置、２・・・ソースプログラム識別
名記憶装置、３・・・ソースプログラム記憶装置、４・
・・プログラム解析装置、５・・・解析データ記憶装置
、６・・・解析データ保守装置、７・・・ドキュメント
出力装置、８・・・ドキュメント、４１・・・ソーステ
キスト読み取り部、４２・・・語彙切り出し部、４３・
・・予約語テーブル、４４・・・構文チェック部、４５
・・・構文規則テーブル、４６・・・解析データ抽出部
、６１・・・削除部、６２・・・複写部、８１・・・シ
ステム設計書、８２・・・プログラム設計書、８３・・
・改造・保守設計書。

Claims (1)

1. 【特許請求の範囲】 １、ドキュメントの生成を行うためのプログラム解析処
   理、解析データの追加・置換・削除処理を含む処理モー
   ドおよび処理対象を指定する処理指定装置（１）と、 この処理指定装置によって、処理対象として指定された
   ソースプログラムの識別名を格納するソースプログラム
   識別名記憶装置（２）と、 ソースプログラム識別名とソーステキストを組とする複
   数のソースプログラムを格納するソースプログラム記憶
   装置（３）と、 前記処理指定装置によりプログラム解析処理が指定され
   たときに、前記ソースプログラム識別名記憶装置に格納
   されたソースプログラム識別名に従って、前記ソースプ
   ログラム記憶装置からソーステキストを読み込み、予約
   語テーブルを参照し、語彙を切り出し、構文のチェック
   を行い、ドキュメントの生成時に参照するデータを抽出
   するプログラム解析装置（４）と、 このプログラム解析装置が抽出した解析データを格納す
   る解析データ記憶装置（５）と、 前記処理指定装置で解析データの追加・置換・削除処理
   が指定されたときに、前記ソースプログラム識別名記憶
   装置に格納されたソースプログラム識別名に従って、前
   記解析データ記憶装置に格納されている解析データを追
   加・置換・削除する解析データ保守装置（６）と、 前記解析データ記憶装置から解析データを読み込み、解
   析データをもとにドキュメント（８）を出力するドキュ
   メント出力装置（７）と を備えたことを特徴とするドキュメント生成方式。