JPH07234783A - ドキュメント自動生成システムにおけるドキュメント情報抽出方式 - Google Patents

Abstract

(57)【要約】 【目的】Ｃ言語で記述されたソースプログラムからドキ
ュメントを逆生成するシステムにおいて、ドキュメント
の情報となるコメントの記述位置がシステムの定めた規
則に従っていない場合でも、簡単な作業で正確な内容の
ドキュメントを出力できるようにすることにある。 【構成】プログラム解析機構４のドキュメント情報抽出
部がコメントをソースプログラムより抽出して文に対応
づける際の規則の制限を緩和し、さらにその対応付け規
則をファイル７に登録できるようにして、利用者の希望
によりプログラム整形機構６で簡単に変更できるように
した。 【効果】保守の対象となるプログラムのドキュメントを
簡単に得ることができ、保守作業の効率を向上させるこ
とができる。

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明は、プログラムの保守に係
り、特に完成後のプログラムを修正する際に必要な情報
を、ドキュメントとして正確に出力するのに好適なリバ
ースエンジニアリングに関する。

【０００２】

【従来の技術】従来の方式は、マイクロコンピュータ用
ドキュメント自動生成ツールAuto−ＤＳ 設計者用マニ
ュアル（Ｃ言語用）に記載のように、ドキュメントの情
報となるコメントをソースプログラム中に記述するため
の規則を決めて利用者に指定しており、その規則に従っ
て記述されていない既存のプログラムに対しては、期待
されない内容のドキュメントが出力される場合があり、
ドキュメントを出力するためにプログラムの修正工数が
必要となっていた。

【０００３】

【発明が解決しようとする課題】上記従来方式は、Ｃ言
語ソースプログラムにおけるコメント記述位置を規則と
して指定しており、この規則を満足していないプログラ
ムに対しては、正確なドキュメント情報の抽出が行われ
ず、期待するドキュメントを得るためにはソースプログ
ラムを修正しなければならないという問題点があった。

【０００４】本発明の目的は、コメント記述規則に従っ
ていない既存のプログラムに対しても、できるだけ工数
を書けずに正確な内容のドキュメントを出力できるよう
にすることにある。

【０００５】

【課題を解決するための手段】上記目的は、ドキュメン
ト情報となるコメントをソースプログラムから抽出し
て、そのコメントと対応する文を認識する際に、コメン
トとその直前と直後の文の各々の位置情報の相関関係に
より対応づける方式を採用し、さらにその対応付けの傾
向をパターン化して登録および変更することを可能にし
て、次の対応付け処理に利用できるようにする機構を構
築することにより達成される。

【０００６】

【作用】本発明の作用を、図１，図２，図３，図４によ
り説明する。

【０００７】ドキュメント抽出部（４−ｃ）は、Ｃソー
スプログラムよりコメントをひとつずつ抽出して、その
コメントの開始位置を示す行ＮｏおよびカラムＮｏと、
終了位置を示す行ＮｏおよびカラムＮｏから構成される
コメント情報（４−ｃ−３）を作成する。さらに、その
コメントの直前に存在する文および直後に存在する文の
構文解析結果をファイル（４−ｂ）から取りだして、前
構文情報(４−ｃ−２)および後構文情報（４−ｃ−４）
を作成する。構文解析結果は、図３のように、構文の種
別や位置情報および文の構成要素等の構文情報により構
成される。

【０００８】ここで、ドキュメント抽出部（４−ｃ）
は、コメント情報（４−ｃ−３）で示されるコメント
が、前構文および後構文のいずれの文を説明するものか
を解析し、対応づける。そして、対応づけられた文の構
文解析結果（４−ｃ−２または４−ｃ−４）の説明の欄
に、コメント情報（４−ｃ−３）で指定されるコメント
の内容を追加し、それをドキュメント情報として出力す
る。

【０００９】上記のコメントの文への対応付け処理にお
いては、コメント情報(４−ｃ−３)と構文解析結果（４
−ｃ−２または４−ｃ−４）の各々の位置情報の関係を
調べて行う。

【００１０】具体的には、コメントと文の行Ｎｏの差を
算出し差が小さい方の文に対応づける、等距離の場合に
はコメントの開始カラム位置が直後の文の開始カラム位
置よりも前または同じであれば直後の文に対応づける、
そうでなければ直前の文に対応づける、などの対応付け
規則に基づき、対応付け処理を行う。

【００１１】通常は、上記のような一般的なＣ言語プロ
グラムの記述方法に基づいた対応づけ規則が登録されて
いる対応付け規則ファイル（７）を参照しながら対応付
け処理を行うが、その規則に従っていないプログラムに
対しては、正しい対応付けを行うことができない場合が
ある。この場合には、利用者（１）がプログラム整形機
構（６）を起動して、プログラムの整形または対応付け
規則の更新を行う。この作業の後、再度プログラム解析
を起動することにより、前回より正確なドキュメント情
報を得ることができる。

【００１２】以上により、コメント記述位置が固定化さ
れていた従来方式に比べ、コメントが規則通りに記述さ
れていなくても対応できるようになったので、コメント
規則に従っていないプログラムに対しても比較的簡単な
作業で正確なドキュメントを得ることができるようにな
る。

【００１３】

【実施例】以下、本発明の実施例を図１から図４により
説明する。

【００１４】図１は、ドキュメント自動生成システムの
システム構成を示すブロック図である。

【００１５】１は、システムの利用者である。２は、Ｐ
Ｃ／ＷＳ等の端末（ディスプレイ装置）である。３は、
出力するドキュメントの元となるＣ言語で記述されたソ
ースプログラムを格納するファイルである。

【００１６】４は、プログラム解析機構であり、Ｃ言語
で記述されたソースプログラム３を解析して、必要なド
キュメント情報８を出力する。８は、ソースプログラム
３に対するファイル単位のドキュメント（設計書）の情
報を格納するファイルである。４−ａでは、ソースプロ
グラム３の構文を解析し、文単位に位置情報や構文情報
からなる構文解析結果情報を作成し、ファイル４−ｂに
出力する。４−ｃでは、ソースプログラム３からドキュ
メントの主要な情報源となるコメントを抽出して、文へ
の対応付け処理を行い、対応づけられた文の構文解析結
果にそのコメントの情報を付加してドキュメントに必要
な情報を作成し、ファイル８に出力する。コメントの文
への対応付けの際には、ファイル７に登録されている対
応付け規則（パターン）を使用して判定する。

【００１７】５は、ドキュメント出力機構であり、ドキ
ュメント情報８を入力し、所定のドキュメント（設計
書）のフォーマットにレイアウトし、プリンタ１０への
印刷または画面２への出力を行う。５−ａでは、前記フ
ァイル単位のドキュメント情報８を入力して、ライブラ
リに登録または複数のファイル単位のドキュメント情報
を連結してプログラム単位のドキュメント情報を作成す
る。５−ｂでは、ドキュメント情報を出力するドキュメ
ントのフォーマットでレイアウト編集を行い、利用者１
の印刷指示に従い、プリンタ１０への印刷または画面２
への表示を行う。６は、利用者１の指示により、コメン
トを文に正確に対応づけることができるようにプログラ
ム構造の整形または対応付け規則の変更を行う機構であ
る。

【００１８】図２は、ドキュメント情報抽出部の構成を
示した図である。ドキュメント抽出部４−ｃは、ソース
プログラムよりコメントを抽出する機構４−ｃ−１と、
抽出したコメントの文への対応付け機構とで構成され
る。コメントの文への対応付け機構は、抽出したコメン
トの情報（図４）を格納するバッファ（４−ｃ−３）
と、そのコメントの直前と直後に存在する文の構文解析
結果（図３）を格納するバッファ（４−ｃ−２および４
−ｃ−４）を有し、対応付け規則７に従って対応付け処
理を行い、ドキュメント情報を作成してファイル８に出
力する。

【００１９】次に、図１および図２により、本システム
の動作について説明する。

【００２０】利用者１が、ドキュメント出力を必要とす
るＣ言語で記述されたソースプログラムのファイル３の
名称を指定してドキュメント自動生成システムのプログ
ラム解析機構４を起動すると、まず構文解析部４−ａに
制御が渡り、ソースプログラムの構文を解析し、プログ
ラムの各文の構文情報や位置情報等からなる構文解析結
果情報４−ｂを生成する。プログラムの全文の解析が終
了すると、ドキュメント情報抽出部４−ｃに制御が移
り、ドキュメントの主要な情報源となるコメントをソー
スプログラム３より抽出して、そのコメントが説明する
文への対応付けを対応付け規則７に従って行い、構文解
析結果情報４−ｂと合わせて、出力するドキュメントに
対応する情報としてまとめ、ファイル８に出力する。

【００２１】ドキュメント情報８が作成されると、通常
は続いてドキュメント出力系機構５が起動される。ま
ず、ドキュメント情報連結・編集部５−ａで、ファイル
単位のドキュメント情報８がライブラリ９に登録され
る。そして、プログラムが複数ファイルに分割されてい
る場合は、複数のドキュメント情報が作成され、ライブ
ラリに登録されることになるので、ここで情報の連結処
理を行い、プログラム単位のドキュメント情報を作成す
る。次に、ドキュメント出力部５−ｂに制御が渡り、こ
こで出力指定のドキュメントのフォーマットにレイアウ
ト編集し、プリンタ１０に印刷する。また、利用者１の
指示により、ドキュメントを画面２に表示することもで
きる。

【００２２】利用者１は、プリンタ１に印刷されるまた
は画面２に表示されるドキュメントをみて、ソースプロ
グラム上のコメントの情報が正確に反映されていない場
合は、プログラム整形をシステムに対して指示する。こ
の場合、プログラム整形機構６が起動され、コメントを
適切な文の説明として入力できるように、プログラムの
構造を整形する。また、コメントの記述位置について
は、プログラムの記述者特有の傾向がある。対応付け規
則ファイル７には、一般的な対応付け規則が登録されて
いるが、利用者１は自分のプログラムの特徴にあった対
応付け規則に変更することができる。

【００２３】上記のプログラム整形あるいはコメントの
対応付け規則の変更を行った後に、利用者１が再びプロ
グラム解析から行うことを指示することにより、より正
確なドキュメントの出力を得ることができる。

【００２４】

【発明の効果】以上述べたように、本発明では、ソース
プログラムからドキュメントの情報源としてのコメント
を抽出して、それがどの文を説明するものかを判定して
対応づける際の対応付け規則を従来より緩和し、さらに
利用者の指示により規則の変更を可能にしたことによ
り、従来よりも簡単な作業で正確な内容のドキュメント
出力を得ることがが可能になったので、保守作業の効率
を向上させることができる。

【図面の簡単な説明】

【図１】ドキュメント自動生成システムのシステム構成
を示す図である。

【図２】ドキュメント情報抽出部の構成を示す図であ
る。

【図３】構文解析結果の１情報分の構成を示す図であ
る。

【図４】コメント情報の１情報分の構成を示す図であ
る。

【符号の説明】

１…システムの利用者、２…ＰＣ／ＷＳ等の端末、３…
Ｃ言語ソースプログラム格納ファイル、４…プログラム
解析機構、５…ドキュメント出力系機構、６…プログラ
ム整形機構、７…コメントの文への対応付け規則格納フ
ァイル、８…ドキュメント情報、９…ドキュメント情報
ライブラリ、１０…ドキュメント印刷用プリンタ。

Claims (2)

【特許請求の範囲】
1. 【請求項１】Ｃ言語で記述されたソースプログラムの文
   の構文を解析して、文単位にその構文の種別，位置情
   報，構成要素等の情報（以下、構文解析結果と呼ぶ）を
   まとめ、所定の書式で出力する構文解析部，ソースプロ
   グラムよりコメントを抽出し、そのコメントが説明する
   文への対応付け処理を行い、対応づけられた文の構文解
   析結果にそのコメントの情報を付加して、さらにその情
   報を出力するドキュメントに対応した情報（以下、ドキ
   ュメント情報と呼ぶ）に変換して出力するドキュメント
   情報抽出部，ドキュメント情報をライブラリ化したり、
   複数のドキュメント情報を連結してプログラム単位のド
   キュメント情報を作成するドキュメント情報連結・編集
   部、ドキュメント情報を指定されたフォーマットにレイ
   アウトして出力するドキュメント情報出力部を有し、ソ
   ースプログラムから必要なドキュメント（設計書）を自
   動的に生成するドキュメント自動生成システムにおい
   て、ソースプログラムからコメント部分を抽出して、そ
   のコメントが説明する文を認識する際に、コメントと文
   の各々の位置情報（行ＮｏとカラムＮｏで構成される）
   の相関関係により判定する方式を採用し、ソースプログ
   ラムのコーディングがシステムが指定したコーディング
   規則（特にコメントの記述規則）に従っていなくても正
   確に情報の抽出を行い、正確なドキュメントの出力を可
   能にしたことを特徴とするドキュメント自動生成システ
   ムにおけるドキュメント情報抽出方式。
2. 【請求項２】請求項１において、正確なドキュメントが
   得られない場合に、コメントを適切な情報として認識で
   きるように付加されたソースプログラムの修正支援機能
   と、文を説明するコメントの記述位置の特徴を利用者の
   指示により登録／変更できる機能から構成されるプログ
   ラム整形機構を付加して、出力するドキュメントの内容
   の正確さを向上させたことを特徴とするドキュメント自
   動生成システムにおけるドキュメント情報抽出方式。