JPH04217023A - ソースプログラム提示装置 - Google Patents

Abstract

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

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明は、ソースプログラムとこ
れに埋め込まれたコメント文を出力してその提示を行な
うソースプログラム提示装置に関する。

【０００２】多くの場合、ソースプログラムはフルスク
リーンのエディタを用いて編集され、その際にコメント
文がソースプログラムに埋め込まれる。

【０００３】

【従来の技術】従来のエディタにおいては、コメント分
の埋め込まれたソースプログラムがそのまま表示されて
おり、そのコメント文部分はソースプログラムの内容を
理解するための説明文，注釈文として利用される。

【０００４】図１２（Ａ），（Ｂ），（Ｃ）にはコメン
ト文が埋め込まれたソースプログラムの一例が示されて
おり、各コメント文の行先頭にはアスタリスクマーク”
＊”が付されている。

【０００５】従来においてはこれらのコメント文が全て
表示されるので、図１２（Ａ），（Ｂ），（Ｃ）のコメ
ント文１，２，３からソースプログラムの概要，両サブ
ルーチンの概要を各々理解でき、さらに、他のコメント
文からソースプログラムの詳細な内容を理解できる。

【０００６】ここで、プログラム内容を他人や初心者に
理解させることを目的とする場合には、そのソースプロ
グラムに詳細なコメント文が図１２（Ａ），（Ｂ），（
Ｃ）のように数多く埋め込まれる。

【０００７】また、プログラム開発後にその開発者や熟
練者がソースプログラムを修正したりこれを他のプログ
ラムで利用することを目的とする場合には、図１２（Ａ
），（Ｂ），（Ｃ）のコメント文１，２，３のみが埋め
込まれる。

【０００８】このように、ソースプログラムに埋め込ま
れるコメント文の数や詳細度はそのソースプログラムを
読む者のレベルにより異なる。

【０００９】

【発明が解決しようとする課題】しかしながら、図１２
（Ａ），（Ｂ），（Ｃ）のソースプログラムをその開発
者や熟練者が読む場合には、ソースリストが煩雑と感じ
られ、かえってプログラム内容の理解の妨げとなる。

【００１０】また、図１２（Ａ），（Ｂ），（Ｃ）のコ
メント文１，２，３のみが埋め込まれていたソースプロ
グラムを他人や初心者が読む場合には、プログラム内容
の十分な理解が困難となる。

【００１１】本発明は上記の事情に鑑みてなされたもの
であり、その目的は、適切なコメント文の付されたソー
スプログラムをその読み手に提示することが可能となる
装置を提供することにある。

【００１２】

【課題を解決するための手段】上記目的を達成するため
に、本発明にかかる装置は図１のように構成されている
。

【００１３】図１において、プログラム読込手段１０は
コメント文が埋め込まれたソースプログラムを読み込み
、出力制御情報設定手段１２は読み込まれたソースプロ
グラム中で指定されたコメント文に対して出力制御情報
を設定する。

【００１４】そして、コメント出力判断手段１４はコメ
ント文が出力対象となるか否かを対応設定の出力制御情
報により判断し、プログラム出力手段１６は出力の対象
となるコメント文をソースプログラムの本体（コメント
文は除かれる）とともに出力する。

【００１５】なお、判断基準情報設定手段１８はコメン
ト出力判断手段１４の判断基準となる情報を予め設定し
、出力制御情報格納手段２０は設定された出力制御情報
をソースプログラムとは別のファイルに格納する。

【００１６】また、出力制御情報挿入手段２２は設定さ
れた出力制御情報をソースプログラム内のコメント文に
挿入する。

【００１７】

【作用】本発明では、ソースプログラムに埋め込まれた
コメント文を任意に指定し、それらに対して出力制御情
報を各々設定することにより、各コメント文の出力制御
を対応の設定情報に応じて行なえる。

【００１８】なお、コメント文が出力対象となるか否か
を判断する際の基準となる情報を設定することにより、
出力すべきコメント文を容易かつ迅速に選択することが
可能となる。

【００１９】また、設定された出力制御情報をソースプ
ログラムとは別のファイルへ格納し、あるいは、ソース
プログラム中のコメント文へ挿入することによりそれら
の情報を保存でき、したがって、出力制御情報のファイ
ルをソースプログラムのファイルとともにオープンして
出力制御情報をソースプログラムと同時に読み込み、あ
るいは、ソースプログラムのコメント文から出力制御情
報を抽出することにより，これら情報の設定を自動的に
行なうことも可能となる。

【００２０】

【実施例】以下、図面に基づいて本発明にかかるソース
プログラム提示装置の好適な実施例を説明する。

【００２１】図２において、処理装置３０の入力部３２
にはキーボード入力のデータが与えられており、そのキ
ーボード入力のデータに従ってファイル３４からはソー
スプログラムを内容とするデータが、また、ファイル３
６からはコメント文の表示制御に使用するデータが、各
々読み込まれる。

【００２２】入力部３２に入力されたデータはコマンド
解析実行部３８へ送出され、ソースプログラムのデータ
及びその編集データはコマンド解析実行部３８から内部
制御部４０に出力される。

【００２３】内部制御部４０ではコマンド解析実行部３
８から入力されたデータがバッファ４２に書き込まれ、
そのバッファデータは出力部４４を介して表示解析部４
６に与えられる。

【００２４】また、コメント文の表示制御コマンドとな
るキーボード入力のデータはコマンド解析実行部３８で
解析され、その解析結果を示すデータはコマンド解析実
行部３８から表示設定部４８へ出力される。

【００２５】表示設定部４８においてはコメント文の番
号，表示／非表示，表示レベル，表示形式などに関して
初期設定の処理がコマンド解析実行部３８の出力（解析
結果）に従って行なわれ、再設定の処理も行なわれる。

【００２６】その表示設定部４８で得られた設定データ
はコメント文管理部５０へ送出され、コメント文管理部
５０により設定情報管理テーブル５２がアクセスされる
。

【００２７】この結果、新たな設定データが設定情報管
理テーブル５２に追加登録され、既登録の設定データが
更新される。

【００２８】なお、ファイル３６がオープンされてその
ファイルから表示制御データが読み込まれた場合には、
表示制御データが初期の設定データとして設定情報管理
テーブル５２に登録される。

【００２９】図３においてはコマンド解析実行部３８，
表示設定部４８，コメント文管理部５０の作用がフロー
チャートで説明されており、コマンド解析実行部３８が
キーボード入力のデータで示されるコマンド（命令）を
受け取ると（ステップ３８０）、その解析が行なわれる
（ステップ３８２，３８４，３８６）。

【００３０】そして、解析結果に応じて登録用または更
新用の設定データ（設定情報）が表示設定部４８で作成
されると（ステップ４８０，４８２）、コメント文管理
部５０によりこのときの設定データが設定情報管理テー
ブル５２へ新規登録され（ステップ５００）、あるいは
、その設定データに既登録の設定データが更新される（
ステップ５０２，５０４）。

【００３１】図４にはファイル３４から読み込まれるソ
ースプログラムの一例が示されており、そのソースプロ
グラムには多数のコメント文が埋め込まれている。

【００３２】このソースプログラムは論理行を単位とし
て読み込まれ、それらの読み込み単位が表示解析部４６
へ順に入力される。

【００３３】図５においては表示解析部４６の作用がフ
ローチャートで説明されており、表示制御部４６に読み
込み単位が入力されると（ステップ４６０）、入力終了
（ファイルエンド）が確認されない場合において（ステ
ップ４６１）、その読み込み単位がコメント文のデータ
か否かが判断される（ステップ４６２）。

【００３４】このデータはコメント文のものでないとき
（プログラムの本体であるとき：ステップ４６２でＮＯ
）に出力制御部５４へ送出され、ディスプレイ５６（プ
リンタも可）で表示される（ステップ４６３）。

【００３５】また、入力された読み込み単位がコメント
文のデータであるときには、これと対応した設定データ
の問い合わせがコメント文管理部５０に対して行なわれ
（ステップ４６４）、対応の設定データが設定情報管理
テーブル５２に登録されていなかったとき（ステップ４
６５でＹＥＳ）には、その読み込み単位のデータは出力
制御部５４へ送出され、ディスプレイ５６において表示
される（ステップ４６６）。

【００３６】そして、対応した設定データが設定情報管
理テーブル５２に登録されていたとき（ステップ４６５
でＮＯ）には、その設定データの解析が行なわれ（ステ
ップ４６７）、コメント文の表示制御が解析結果に応じ
て行なわれる（ステップ４６８）。

【００３７】図６ではコメント文表示の制御作用が説明
されており、ソースプログラムに埋め込まれたコメント
文のうち、表示の対象となるものの位置にそのコメント
文の番号１，８が表示されている。

【００３８】また、これら番号１，８はソースプログラ
ムの下段においても表示され、両番号１，８の各下側に
おいて表示番号１，８と対応したコメント文が表示（こ
こでは反転表示）される。

【００３９】図７ではこのときのテーブル内容が説明さ
れており、番号１，６，７，８，９，１０のコメント文
が表示の対象とされている。

【００４０】さらに、コメント文の表示形式は図８の表
示が行なわれたときにおいて入力されたキーボードデー
タに従って表示解析部４６で設定される。

【００４１】同図においてはコメント文の表示レベルが
３以上で”通常表示”，”脚注表示”が選択されており
、このため、上述した図６の表示が行なわれる。

【００４２】なお、４以上の表示レベルが選択されると
番号１のコメント文のみが表示され（図７参照）、色別
表示が選択されるとソースプログラムとは別の色であっ
て表示レベル毎に異なる色によりコメント文が表示され
る。

【００４３】また、番号指定表示が選択されたときには
コメント文は初期表示されず、ソースプログラム中に表
示された番号（図６参照）が指定されることにより、対
応のコメント文が分割画面またはウインドウに表示され
る。

【００４４】図９ではコメント文の表示形態を変更する
ための処理手順が説明されており、最初に各コメント文
について表示制御データのキーボード入力が受け付けら
れる（ステップ９００）。

【００４５】その際には図１０で示されるように、該当
コメント文の先頭と末尾にリージョンマークが自動的に
各々付加され、コメント文の近傍に表示設定のウインド
ウが開かれる。

【００４６】このウインドウにはコメント文の番号（＝
７），表示有無（＝表示：１），表示レベル（＝１）が
予め自動入力されており、それらは必要に応じキーボー
ド入力のデータに従って変更される。

【００４７】そして全てのコメント文について表示制御
データが受け付けられると、それらの設定データが設定
情報管理テーブル５２に格納される（ステップ９０２）
。

【００４８】さらにコメント文の表示形式が上述のよう
にして選択されると（ステップ９０４）、設定情報管理
テーブル５２から設定データが取り出され（ステップ９
０６）、対応の設定データに応じて各コメント文が選択
の形式で表示制御される（ステップ９０８，９１０）。

【００４９】その後においてソースプログラムの編集が
終了したときには（ステップ９１２でＹＥＳ）、ソース
プログラムのデータがファイル５８へ出力され（ステッ
プ９１４）、設定情報管理テーブル５２の内容が別のフ
ァイル６０へ出力される（ステップ９１４）。

【００５０】なお、図１１で示されるようにコメント文
を表示制御する設定データを対応のコメント文へ挿入す
ることも好適である。

【００５１】以上説明したように本実施例によれば、ソ
ースプログラムに埋め込まれたコメント文を指定して表
示制御データを設定すると、各コメント文の表示制御が
対応の設定データに応じて行なわれるので、装置利用者
は表示されるコメント文を自己のレベルに合わせて適切
に選択でき、このため、そのソースプログラムに不慣れ
な者は豊富な量で詳細な内容のコメントが付されたソー
スリストを得ることによりその内容を十分に理解するこ
とが可能となる。

【００５２】またこのソースプログラムに習熟した者は
、必要なコメントのみが付された簡素で見易いソースリ
ストを表示させることにより、その内容を容易に理解す
ることが可能となる。

【００５３】さらに本実施例によれば、コメント文が出
力対象となるか否かの判断基準となるデータ（図８参照
）を設定できるので、装置利用者は自己のレベルに合わ
せてコメント文を容易かつ迅速に選択することが可能と
なる。

【００５４】そして、設定された表示制御データをソー
スプログラムとは別のファイル６０へ格納（あるいはソ
ースプログラムのコメント文中へ挿入）することにより
、それらのデータを保存でき、したがって、表示制御デ
ータのファイル３６（５８））をソースプログラムのフ
ァイル３４（５８）とともにオープンして表示制御デー
タをソースプログラムと同時に読み込む（あるいは、ソ
ースプログラムのコメント文から表示制御データを抽出
する）ことにより、それら表示制御データの設定を自動
的に行なうことが可能となり、このため、表示制御デー
タの再設定作業を不要化して装置の操作性を大幅に高め
ることができる。

【００５５】また、コメント文がソースプログラムとは
別の位置に表示されるので、コメント文及びソースプロ
グラムの視認性を高めることも可能となる。

【００５６】

【発明の効果】以上説明したように本発明によれば、ソ
ースプログラムに埋め込まれたコメント文を選択出力で
きるので、利用者の能力や習熟度に合致した適切なコメ
ント文の付されたソースリストが得られ、このため、プ
ログラムの開発をより良好な環境で行なうことが可能と
なる。

【図面の簡単な説明】

【図１】発明の原理説明図である。

【図２】実施例の構成説明図である。

【図３】実施例における表示制御データの設定作用を説
明するフローチャートである。

【図４】実施例で取り扱われるソースプログラムの説明
図である。

【図５】実施例のコメント文表示作用を説明するフロー
チャートである。

【図６】実施例におけるソースプログラム及びコメント
文の表示画面説明図である。

【図７】設定情報管理テーブルの内容説明図である。

【図８】実施例におけるコメント文表示形式の選択作用
説明図である。

【図９】実施例におけるコメント文表示形態の変更作用
を説明するフローチャートである。

【図１０】実施例における表示制御データの設定作用説
明図である。

【図１１】表示制御データをソースプログラムのコメン
ト文に挿入する作用の説明図である。

【図１２】コメント付ソースプログラムの説明図である
。

【符号の説明】

３０　処理装置 ３２　入力部 ３４　ソースプログラムの入力ファイル３６　表示制御
データの入力ファイル ３８　コマンド解析実行部 ４０　内部制御部 ４２　バッファ ４４　出力部 ４６　表示解析部 ４８　表示設定部 ５０　コメント文管理部 ５２　設定情報管理テーブル ５４　出力制御部 ５６　ディスプレイ ５８　ソースプログラムの出力ファイル６０　表示制御
データの出力ファイル

Claims (3)

【特許請求の範囲】
1. 【請求項１】　　コメント文が埋め込まれたソースプロ
   グラムを読み込むプログラム読込手段（１０）と、指定
   されたコメント文に対して出力制御情報を設定する出力
   制御情報設定手段（１２）と、コメント文が出力対象と
   なるか否かを対応設定の出力制御情報により判断するコ
   メント出力判断手段（１４）と、出力の対象となるコメ
   ント文をソースプログラムの本体とともに出力するプロ
   グラム出力手段（１６）と、を有する、ことを特徴とす
   るソースプログラム提示装置。
2. 【請求項２】　　コメント文が埋め込まれたソースプロ
   グラムを読み込むプログラム読込手段（１０）と、指定
   されたコメント文に対して出力制御情報を設定する出力
   制御情報設定手段（１２）と、コメント文が出力対象と
   なるか否かを対応設定の出力制御情報により判断するコ
   メント出力判断手段（１４）と、コメント出力判断手段
   （１４）の判断基準となる情報を予め設定する判断基準
   情報設定手段（１８）と、設定された出力制御情報をソ
   ースプログラムとは別のファイルに格納する出力制御情
   報格納手段（２０）と、出力の対象となるコメント文を
   ソースプログラムの本体とともに出力するプログラム出
   力手段（１６）と、を有する、ことを特徴とするソース
   プログラム提示装置。
3. 【請求項３】　　コメント文が埋め込まれたソースプロ
   グラムを読み込むプログラム読込手段（１０）と、指定
   されたコメント文に対して出力制御情報を設定する出力
   制御情報設定手段（１２）と、コメント文が出力対象と
   なるか否かを対応設定の出力制御情報により判断するコ
   メント出力判断手段（１４）と、コメント出力判断手段
   （１４）の判断基準となる情報を予め設定する判断基準
   情報設定手段（１８）と、設定された出力制御情報をソ
   ースプログラム内のコメント文中に挿入する出力制御情
   報挿入手段（２２）と、出力の対象となるコメント文を
   ソースプログラムの本体とともに出力するプログラム出
   力手段（１６）と、を有する、ことを特徴とするソース
   プログラム提示装置。