JPH04195529A - 注釈文付加方式 - Google Patents

Abstract

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

Description

【発明の詳細な説明】 〔産業上の利用分野〕 本発明は、プログラムに注釈文を付加する注釈文付加方
式に関し、特に変数名の詳細説明を注釈文としてプログ
ラムに付加する方式に関する。

〔従来の技術〕

従来より、プログラム言語を用いたプログラムの多（は
、変数概念と条件分岐や繰返し等の流れ制御とを基本と
して、目的とする処理や機能を手続的に表現するものと
なっている。このため、現在のプログラムを改造する等
のためにプログラム内容を把握するには、プログラム中
に出てくる変数名が何を意味するのかを認識する必要が
ある。

特に、プログラム開発者以外の人がそのプログラム内容
を理解するには、変数名の意味を知ることは不可欠であ
る。

ところで、従来のプログラムには、全ての変数名に注釈
が付加されていることは殆どなく、注釈が加えられてい
るプログラムの他の部分を見たり、プログラム仕様書等
を見る等で変数名の意味を確認していた。例えば、Ｃ０
ＢＯＬで作成されたプログラムで手続き部（ＰＲＯＣＥ
ＤＵＲＥ　Ｄ［ＶＩＳＩＯＮ）を調ヘルときは、その中
で変数名が出てくる毎にデータ部（ＤＡＴＡ　ＤＴＶＴ
ＳＩＯＮ）を調へて、その変数名が何の意味を示すのか
を確認することが一般的であった。

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

しかし、上述した従来の方法で変数名の意味を確認して
いると、プログラムの文の量が多い場合や利用される変
数名が多い場合に、変数名の確認作業に非常に長い時間
がかかることになる。

このため、プログラムの改造工数は増大し、さらにはデ
バッグ作業工数も増大し、プログラムの生産性が極めて
低（なるという欠点がある。

また、変数名が複雑であったり、似た変数名が多かった
りすると、その変数名を間違って理解してしまい易く、
間違ったプログラムに改造してしまい、保守性や信較性
等が低くなるという欠点もある。

さらに、プログラム開発者が予めプログラムの全ての変
数名に注釈文を付加しておくことも考えられるが、開発
者が変数名毎にその都度注釈文を付加していくことは、
プログラムの生産工数を増大させ、プログラムの生産効
率を極めて低下させるという欠点もある。

本発明の目的は、プログラムの変数名に自動的に注釈文
を付加できる注釈文付加方式を提供することにある。

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

本発明の注釈文付加方式は、プログラムが記憶された記
憶手段よりプログラムを読み出して保持するプログラム
保持手段と、このプログラム保持手段により保持された
プログラムから変数名を検索する変数名検索手段と、任
意の変数名に対して付加する注釈が予め記憶されている
注釈記憶手段と、前記変数名検索手段で検索された変数
名に基づいて注釈記憶手段からこの変数名に対応する注
釈を検索する注釈検索手段と、前記変数名検索手段で検
索された変数名の記述形式に応して注釈検索手段で検索
された注釈を注釈文として編集する注釈文編集手段と、
注釈文編集手段により編集された注釈文および前記プロ
グラムを出力する出力手段とを有している。

〔作用〕

このような本発明においては、プログラム保持手段によ
り記憶手段からプログラムが読み出されて保持されると
、変数名検索手段により保持されたプログラム中に変数
があるかどうか検索される。

ここで、変数名が見つかると、注釈検索手段によりその
変数名に対応する注釈が注釈記憶手段から検索される。

この注釈は、プログラム中の変数名の記述形式に応じて
注釈文編集手段により注釈文に編集され、この注釈文は
出力手段によりプログラムに付加された形で出力される
。

このため、出力されたプログラムには、各変数名毎に注
釈文が自動的に付加され、これにより前記目的が達成さ
れる。

［実施例］ 次に、本発明について図面を参照して説明する。

第１図は、本発明の一実施例の構成を示すブロック図で
ある。

注釈文付加手段１には、プログラム記憶手段２が接続さ
れている。プログラム記憶手段２は、ソースプログラム
が格納される外部記憶装置であって、フロッピーディス
ク装置、磁気ディスク装置等で構成されている。

注釈文付加手段１は、プログラム記憶手段２からソース
プログラムをレコード単位（１行単位）で読み出して保
持するソースプログラム保持手段１１を備えている。こ
のソースプログラム保持手段１１には、変数名検索手段
１２が接続されている。

変数名検索手段１２は、保持されたプログラムの中に変
数名が存在するかどうかを検索し、変数名が存在する場
合にはその変数名を注釈検索手段１３に渡す。

注釈検索手段１３は、変数名検索手段１２がら渡された
変数名に対する注釈を注釈記憶手段１４から検索し、注
釈文編集手段１５にその変数名とともに渡す。

注釈記憶手段１４は、当該方式が展開される計算機等の
主記憶装置などの内部記憶手段により構成され、第２図
に示すように、プログラムに用いられた変数のうち、任
意の変数に対する説明等が注釈として、その変数名に対
応したテーブル形式で格納されている。この注釈記憶手
段１４への注釈の入力は、キーボード４Ａや外部記憶装
置４Ｂ等を備えた注釈入力手段４により行われる。

注釈文編集手段１５は、注釈検索手段１３から渡された
変数名とその注釈を、保持されたプログラムの記述形式
に合わせて利用者の見やすい形式で１行の注釈文に編集
し、この注釈文を出力手段１６に渡す。

出力手段１６は、渡された注釈文を出力装置３あるいは
プログラム記憶手段２へ出力するよう構成されている。

この出力装置３は、ソースプログラムを出力する装置で
あり、例えばプリンタ装置、デイスプレィ装置等で構成
されている。

次に、このように構成された本実施例の動作について第
３図ないし第５図をも参照して説明する。

最初に、注釈入力手段４により、注釈記憶手段１４に変
数名とその名称等の注釈とを登録しておく。

その後、ソースプログラム保持手段１１により、プログ
ラム記憶手段２から、第４図に示すように、ソースプロ
グラム２Ａから所定のレコード２Ｂを入力する（ステッ
プＡ）。

次に、言語処理システムルーチン等でソースプログラム
２Ａの終す判定を行う（ステップＢ）。

この終了判定は、通常のプログラムの最終行に書き込ま
れるＥＯＦレコードまたはマーク等で判断される。

ソースプログラム２Ａが終了していない場合、ソースプ
ログラム保持手段１１は現在保持しているレコード２Ｂ
を出力手段１６に渡し、このレコード２Ｂは出力手段１
６により出力装置３に出力される（ステップＣ）。

その後、変数名検索手段１２により、ソースプロクラム
保持手段１１に保持されたレコード２Ｂにｉ数名が存在
するかどうかの検索が行われる（ステップＤ　）。この
際、変数名が存在しない場合は、ステップＡに戻りソー
スプログラム２Ａから次のレコードの入力を実行する。

一方、変数名が存在する場合には、注釈検索手段１３に
より、その変数名に対応する注釈を注釈記憶手段１４か
ら検索する（ステップＥ）６例えば、第４図に示すレコ
ード２Ｂの中には、Ｄ５．　Ａ３．　Ｄ４の３つの変数
名が存在しており、これらの変数の名称や説明等の注釈
を注釈記憶手段１４から検索すると、各変数名Ｄ４、Ａ
３、Ｄ４に対して、それぞれ金額、単価、数量という注
釈が得られる。

注釈検索手段１３で検索された注釈は、注釈文編集手段
１５に送られ、利用者の見やすい形式の注釈文に編集さ
れ（ステップＦ）、出力手段１６により出力装置３に出
力される（ステップＧ）。

以上の動作の結果、出力装置３がらは、第５図に示すよ
うに、先に出力されたレコード２Ｂに続いて注釈文２Ｃ
が出力される。すなわち、注釈文付加手段１に入力され
たソースプログラム２Ａは、注釈文２Ｃが付加されたソ
ースプログラム３Ａとして出力される。

このような本実施例によれば、ソースプログラム保持手
段１１、変数名検索手段１２、注釈検索手段１３、注釈
記憶手段１４、注釈文編集手段１５、出力手段１６等を
設けたので、プログラム記憶手段２がら読み込んだソー
スプログラム２Ａに対し、これに含まれる各変数名の意
味を示す注釈文を自動的に付加し、注釈文付加済のソー
スプログラム３Ａとして出力装置３から出力できる。

このため、プログラム開発者等がプログラム作成時に変
数名の注釈文を付加する必要がなく、プログラム製造工
数も減少し、プログラム生産性も高くできる。

また、変数名が複雑であったり似た変数名が多かったり
したため、変数名を間違って使用あるいは理解した場合
等でも、注釈文を参照することにより変数名等の間違い
を容易に発見でき、プログラムのデバッグ作業を極めて
容易にできるとともに、プログラムの保守性や信頼性を
高くできる。

さらに、プログラム開発者以外の者が、プログラム改造
等のために当該プログラムを調査する必要がある場合に
、変数名の注釈文を参照することができるため、変数名
の確認作業に時間がかからずプログラム内容を容易に理
解できる。

このため、プログラム改造工数やデバッグ作業工数を減
少でき、プログラムの生産性を高くできる。

また、注釈記憶手段１４には、注釈入力手段４により変
数名および注釈を容易に登録できるので、注釈記憶手段
１４内の内容を変更することで様々なプログラムに対し
て本実施例の注釈文付加方式を用いることができる。

尚、本発明は前記実施例の構成等に限らず、本発明の目
的を達成できる範囲の変形は本発明に含まれるものであ
る。

例えば、前記実施例では、プリンタ装置やデイスプレィ
装置で構成される出力装置３に注釈文が付加されたソー
スプログラム３Ａを出力していたが、ソースプログラム
が記憶されているプログラム記憶手段２に出力し、注釈
文が付加された形でソースプログラムを記憶させておい
てもよい。

また、注釈記憶手段１４に変数名や旺釈が記憶される記
憶頭載をプログラム毎に設けて、複数のプログラムに対
応させてもよい。

さらに、本発明の注釈文付加方式は、ソースプログラム
だけでなく、オブジェクトプログラムや中間プログラム
等の様々なプログラムに広範に利用できる。

〔発明の効果〕

以上説明したように本発明は、プログラム保持手段、変
数名検索手段、注釈検索手段、注釈記憶手段、注釈文編
集手段および出力手段を設けたことにより、プログラム
中に含まれる変数名に対して各々の意味を示す注釈文を
自動的に付加できるため、注釈文付加前のプログラムが
簡単に得られ、プログラム開発の効率を大幅に向上でき
るという効果がある。

【図面の簡単な説明】

第１図は本発明の一実施例の構成を示すブロック図、第
２図は前記実施例の注釈記憶手段を示す概念図、第３図
は前記実施例の動作を示す流れ図、第４図は注釈文付加
前のソースプログラムの一例を示す概念図および第５図
は注釈文付加前のソースプログラムの一例を示す概念図
である。 １・・・注釈文付加手段、２・・・プログラム記憶手段
、３・・・出力装置、４・・・注釈入力手段、１１・・
・ソースプログラム保持手段、１２・・・変数名検索手
段、１３・・・注釈検索手段、１４・・・注釈記憶手段
、１５・・・注釈文編集手段、１６・・・出力手段。

Claims (1)

【特許請求の範囲】
1. （１）プログラムが記憶された記憶手段よりプログラム
   を読み出して保持するプログラム保持手段と、 当該プログラム保持手段により保持されたプログラムか
   ら変数名を検索する変数名検索手段と、任意の変数名に
   対して付加する注釈が予め記憶されている注釈記憶手段
   と、 前記変数名検索手段で検索された変数名に基づいて注釈
   記憶手段から当該変数名に対応する注釈を検索する注釈
   検索手段と、 前記変数名検索手段で検索された変数名の記述形式に応
   じて注釈検索手段で検索された注釈を注釈文に編集する
   注釈文編集手段と、 注釈文編集手段により編集された注釈文および前記プロ
   グラムを出力する出力手段と、 を有することを特徴とする注釈文付加方式。