JPH04340130A - プログラム情報のドキュメント化方式 - Google Patents

Abstract

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

Description

【発明の詳細な説明】

【０００１】

【産業上の利用分野】本発明はプログラム情報作成装置
において、コンピュータプログラムの保守作業等の利便
性を高めるために、必要に応じてプログラム情報をドキ
ュメント化して出力することを可能にしたプログラム情
報のドキュメント化方式に関する。

【０００２】

【従来の技術】コンピュータプログラムの記述は、ソー
スコードと呼ばれる字句を最小構成単位として行われる
。また、ソースコードをＣＯＢＯＬ、Ｃ等のプログラミ
ング言語の構文規則に従って羅列したものをソースプロ
グラムと呼ぶ。ソースプログラムはエディタと呼ばれる
編集手段により作成し、作成したソースプログラムはコ
ンパイラと呼ばれる変換手段により機械語に翻訳され、
実行可能なコンピュータプログラムとしての形態をとる
。このようにコンピュータプログラムとソースプログラ
ムは等価なものであり、コンピュータプログラムの機能
を最も実直に表現したものがソースプログラムと言える
。

【０００３】コンピュータプログラムの作成、保守作業
においては、再利用や仕様把握のために既存のソースプ
ログラムを見るケースが多く、また、その内容を理解す
る必要がある。しかし、ソースコードはコンピュータプ
ログラムの機能を記述するためのものであり、記号的な
表現が多い。そのため、これを羅列したソースプログラ
ムは必ずしも作業員にとって見易く、理解しやすい形態
ではない。

【０００４】従来、このような問題を解決する手法とし
て、コメント情報とよばれる注釈をソースプログラム中
へ記述することや、ソースプログラムのインデント（字
下げ）付けによる区切りの強調や、ソースプログラム中
へ、ＳＳ（Ｓｔｒｕｃｔｕｒｅ　Ｓｐｅｃｉｆｉｃａｔ
ｉｏｎ）情報（入力・出力等、あるまとまった機能単位
の仕様を記述したもの）をコメント情報の形で記述する
ことなどが行われてきたが、満足の行く効果は得られて
いなかった。

【０００５】これに対し、例えば特開昭６１−２４８１
３３号公報に記載のように、ソースプログラム中の任意
のソースコード部分に、色付けや罫線付加等の表示属性
を与え、ソースプログラムを表示する際、表示属性を反
映することでソースプログラムを読みやすくする工夫が
一部で提案されている。

【０００６】

【発明が解決しようとする課題】コンピュータプログラ
ムの保守作業において重要な点は、ソースコードやコメ
ント情報、ＳＳ情報などが渾然したプログラム情報中か
ら、いかにしてプログラミング言語の文法規則に根ざし
た制御構造を見いだすか、また、ＳＳ情報を基に、どの
ようにしてプログラム全体の仕様を把握するかにある。 よって、真に可読性の高いプログラム情報とは、その制
御構造、及び仕様を目で見て（視覚的に）容易に把握で
きるものだと言える。

【０００７】しかしながら、上述のソースプログラム中
の任意のソースコード部品に色付けや罫線付加を施こし
て表示する方式は、単にプログラム情報を構成する一つ
であるソースプログラムの表現方法を一部変えることで
、ソースプログラムを部分的に読む上でのマーカを与え
るに過ぎず、プログラム情報全体としての制御構造、及
び仕様の容易な把握ができるまでには至っていない。

【０００８】一般的には本（ドキュメント）と呼ばれる
ものは、字下げ、段落下げ、脚注等により情報の構造化
を図ると共に、図表、強調など視覚に訴える表現を取り
入れるなどして、様々な情報を読者に分かりやすく読ま
せる事が主眼におかれている。さらには膨大な情報中か
ら、必要な情報を迅速に取得するための目次、索引等、
各種の検索情報をも備えている。

【０００９】本発明の第１の目的は、上記ドキュメント
の概念をプログラム情報に取り入れることで、プログラ
ム情報そのものをコンピュータプログラムの仕様を記述
した一冊の本（ドキュメント）とすることにある。

【００１０】本発明の第２の目的は、プログラム情報中
のソースプログラムに対し、その制御構造が視覚的に容
易に判別できる形態に成形することにある。

【００１１】本発明の第３の目的は、プログラム情報中
のＳＳ情報を、プログラムの仕様が視覚的に容易に判別
できる形態に成形すると共に、必要とするＳＳ情報を迅
速に検索し得るようにすることにある。

【００１２】

【課題を解決するための手段】請求項１の発明は、一般
的なプログラム情報作成装置を構成する、プログラム情
報編集手段、プログラム情報記憶手段、プログラム情報
出力手段などに加えて、すでに作成されて記憶されてい
るプログラム情報に対して構文解析を行い、コメント及
び制御構造のキーとなる部分を検出し、それを解析情報
として記憶する手段と、前記解析情報をもとに当該プロ
グラム情報を、そのプログラム仕様及び制御構造が視覚
的に判別しやすい表現のドキュメントに成形する手段と
を設けたことを特徴とする。

【００１３】また、請求項２の発明は、前記ドキュメン
トを成形する手段では、プログラム情報のドキュメント
化に加えて、当該ドキュメントの目次、索引も生成する
ことを特徴とする。

【００１４】

【作用】プログラム情報のドキュメント化により、プロ
グラム情報中のソースプログラムに対し、その制御構造
が視覚的に容易に判別できる形態に成形される。また、
プログラム情報中のＳＳ情報も、プログラムの仕様が視
覚的に容易に判別できる形態に成形されると共に、さら
に、ドキュメントに目次、索引をつけることにより、必
要とするＳＳ情報を迅速に検索し得るようになる。

【００１５】

【実施例】以下、本発明の一実施例について図面により
説明する。

【００１６】図１は本発明の一実施例のシステム構成図
を示す。図１において、１０１はキーボード、１０２は
マウス、１０３はプログラム情報記憶装置、１０４はデ
ータ処理装置、１１１は解析情報記憶装置、１１２は表
示装置、１１３は印刷装置である。データ処理装置１０
４はハードウェア的にはＣＰＵやＲＯＭ、ＲＡＭなどで
構成されるが、ここでは機能上、制御手段１０５、プロ
グラム情報編集手段１０６、プログラム情報ドキュメン
ト化手段１０７、プログラム情報成形用バッファ１０８
、プログラム情報解析手段１０９及びプログラム情報出
力手段１１０に大別される。

【００１７】本システム全体は制御手段１０５による制
御の下で稼働する。プログラム情報を新規に作成する場
合、利用者は入力手段であるキーボード１０１、マウス
１０２を用い、表示装置１１２を見ながら入力作業を行
う。入力情報は制御手段１０５を通して編集手段１０６
へ取り込まれて編集される。こうして作成されたプログ
ラム情報は記憶装置１０３に記憶し、また、必要に応じ
てプログラム情報成形用バッファ１０８、プログラム情
報出力手段１１０を介して表示装置１１２や印刷装置１
１３に出力する。すでに作成されたプログラム情報を修
正する場合は、記憶装置１０３から当該プログラム情報
を編集手段１０６に取り出すと共に、該プログラム情報
をプログラム情報成形用バッファ１０８、プログラム情
報出力手段１１０を介して表示装置１１２に表示する。 利用者は表示装置１１２を見ながら、キーボード１０１
、マウス１０２を用いて修正作業を行い、その情報を制
御手段１０５を通じて編集手段１０６が受け取り、プロ
グラム情報を編集し直す。こうして修正されたプログラ
ム情報を再び記憶装置１０３に記憶し、また、必要に応
じて表示装置１１２や印刷装置１１３に出力する。これ
らの働きは、従来からある一般的なプログラム情報作成
装置と同様である。

【００１８】図１の実施例では、上記の構成の他にプロ
グラム情報そのものをコンピュータプログラムの仕様を
記述した一冊の本（ドキュメント）として成形するため
に、プログラム情報ドキュメント化手段１０７、プログ
ラム情報解析手段１０９及び解析情報記憶手段１１１が
存在する。

【００１９】図２はプログラム情報のドキュメント化の
処理手順を示したものである。ドキュメント化手段１０
７は、まず、ドキュメントとしての表紙を生成する（ス
テップ２０１）。続いて、ドキュメント化を行うプログ
ラム情報を記憶装置１０３から成形用バッファ１０８上
に読み込む（ステップ２０２）。次に、この読み込んだ
プログラム情報に対して解析手段１０９が構文解析を行
い、コメントや制御構造のキーとなる部分が存在する位
置を検出し、解析情報として解析情報記憶装置１０９に
記憶する（ステップ２０３）。続いてドキュメント化手
段１０７は、解析情報とプログラム情報を照らし合わせ
ながらバッファ１０８上でドキュメントの成形を行い、
ドキュメントにおける本文に相当する部分を生成する（
ステップ２０４）。そして、ドキュメント化を指定した
プログラム情報がまだある場合は、次のプログラム情報
を読み込み、本文生成を繰り返す（ステップ２０５）。 ドキュメント化手段１０７は、本文の生成が終了すると
、ドキュメントの目次を生成し（ステップ２０６）、最
後にドキュメントの索引を生成する（ステップ２０７）
。このようにしてドキュメントとして成形された情報を
、出力手段１１０により目的に応じて表示装置１１２か
印刷装置１１３へ出力する（ステップ２０８）。

【００２０】図３はプログラム情報の階層構造を示す図
である。一般に一つのプログラム情報は、入力、出力等
、まとまった機能ごとにモジュールとよばれる単位にま
とめられている。モジュールは、さらにその内部処理の
単位に応じて関数とよばれる単位に分けることができる
。図４に、プログラミング言語の一種であるＣ言語で記
述された、関数のプログラム情報（以下、Ｃプログラム
情報）の一例を示す。以下、図４に示すＣプログラム情
報を例に取り、プログラム情報の説明を行う。

【００２１】プログラム情報中のソースプログラムは、
本体であるコーディング情報４０３と、ソースコードの
処理内容を注釈として記述したコメント情報４０４から
成る。図４に示すように、Ｃ言語においては、“／＊“
と“＊／”に囲まれた範囲がコメント情報であり、プロ
グラム情報４０１中のどの部分にでも記述することがで
きる。４０２はＳＳ情報と呼ばれ、モジュール単位、関
数単位の機能仕様を明確にするために、関数の宣言行（
開始行）前部にヘッダとして添えたコメント情報である
。ＳＳ情報を与えることで、保守作業における機能仕様
の把握を効果的に行うことができるため、プログラミン
グ時に添えることが多い。このようにコメント情報はコ
ーディング情報を理解する上での補助と成り得るが、そ
の反面、プログラム情報作成時において、コメント情報
の配置に十分な注意を払わないと、コメント情報がコー
ディング情報中で埋もれてしまうと同時に、両情報が渾
然一体となってしまい、却ってプログラム情報が読み難
くなる。

【００２２】図４において、関数の開始位置は４０５で
あり、終了位置は４０６である。そしてその間に、機能
を制御する判定命令４０７や繰り返し命令４０８が含ま
れている。コーディング情報４０３中には、このように
制御構造のキーとなる部分が存在するが、実際のプログ
ラム情報では複数の関数が連なっている上に、記号的英
数字であるソースコードの羅列であるため、一見しただ
けではキーとなる部分を判別し難い。このような問題は
、プログラム情報のドキュメント化により解決すること
ができる。

【００２３】以下に、プログラム情報を例にしてドキュ
メント化を詳述する。初めに、ドキュメントにおける本
文の生成（図２のステップ２０４）について図４と図５
を用いて説明する。本文の生成においては、プログラム
情報に様々な視覚的表現を施すが、ここでは具体例とし
て三例を示す。

【００２４】第一は、ＳＳ情報の効果的表現である。ま
ず、図４におけるＳＳ情報４０２を、プログラム情報解
析処理（図２のステップ２０３）により検出したＳＳ情
報中のキーワードとなる語を基に、情報の切り分けを行
い、図５の５０２のようにドキュメントにおける“見出
し”部分のイメージで、ソースコードにはない表現に成
形する。図５では、ＳＳ情報中のコメント情報を罫線で
囲い、関数名称に網掛けを施こした例を示している。こ
れにより、関数と関数の区切りが明確になると共に、ソ
ースコードとＳＳ情報との混同を避けることができる。 ＳＳ情報切り分けのキーワードとなる語に対しては、ス
テップ２０３の構文解析時にＳＳ情報キーワードの入力
誘導機能が働き、情報の欠如を補う方向へユーザを誘導
する。図５で５０２に示したのは、関数のＳＳ情報であ
るが、関数の上位階層に属するモジュールのＳＳ情報は
、これとはまた異なるフォーマットで表現することで、
他のモジュールとの区切りを明確にしている。

【００２５】第二は、ソースプログラム中のコーディン
グ情報に対して付されたコメント情報の効果的表現であ
る。図４のコーディング情報４０３に付したコメント情
報４０４は、コーディング情報を配置するカラムとコメ
ント情報を配置するカラムを別個に設け、それぞれのカ
ラムに該当情報を再配置することで、ソースプログラム
中に混在していたコーディング情報、コメント情報を明
確に分けることができる。図５では、コメント情報のカ
ラム５０３を左に、コーディング情報のカラム５０４を
右に配置した例を示している。また、コメントの付け方
次第では、コメント情報のカラムを読むだけでコーディ
ング情報を理解することも可能である。

【００２６】第３は、プログラム制御構造の明示である
。コーディング情報中に存在する制御構造のキーとなる
語の文字の出力形態を他と変えることで、制御機構を目
で見て、分かりやすく表現する。図４のプログラム情報
４０１のコーディング情報４０３中に存在する判定命令
４０７や繰り返し命令４０８をイタリック体の文字フォ
ントで表現した例が、図５の５０５である。また、図５
に５０６で示したように、ユーザの指定により命令語の
制御の及ぶ範囲を表示することも可能である。他にも、
図５では関数の開始、終了位置の明示（５０７）や、関
数に入力として与えられる変数を他の変数と文字フォン
トを変えて表現している（５０８）。

【００２７】次に、ＳＳ情報の検索手段である目次、索
引の生成（図２のステップ２０６，２０７）について、
図６を用い説明する。

【００２８】本ドキュメントでは、内容の段落分けを行
い、目次や、索引の添付、ページ付けなどにより、目的
箇所の迅速な検索が可能となっている。プログラム情報
も図３に示した階層的構造をとるため、ドキュメントに
おける章や段落付けの概念を導入することができる。

【００２９】コンピュータプログラムの構成単位の内、
何を章、段落とするかは任意に指定することができるが
、図６では、モジュールを章、関数を段落とした場合の
目次、索引の生成例を示している。図６に示したプログ
ラム情報はメイン、サブのモジュールから成り、メイン
モジュール内に関数６０６、サブモジュール内に関数６
０７と６０８があるとしている。まず、ドキュメント化
手段１０７では、６０６は６０３へ、６０７は６０４へ
、６０８は６０５へと成形する。次に、章の掲載ページ
数を目次６０１として生成する。さらに段落の掲載ペー
ジ数を索引６０２として生成する。ここで、索引６０２
はアルファベット順に段落名（関数名）をソートした例
である。

【００３０】図５、図６に示したように、プログラム情
報のドキュメント化により、プログラム情報中のソース
プログラムに対し、その制御構造が視覚的に容易に判別
できると共に、プログラム情報中のＳＳ情報を、プログ
ラムの仕様が視覚的に容易に判別できる形態に成形し、
さらに必要とするＳＳ情報を迅速に検索するための目次
、索引などを持つところの、コンピュータプログラムの
機能仕様を最も実直に表現したドキュメントとしてのプ
ログラム情報を得ることができる。

【００３１】

【発明の効果】以上の説明から明らかな如く、本発明に
よれば、プログラム情報のドキュメント化により、プロ
グラム情報中のソースプログラムに対し、その制御構造
が視覚的に判別できる形態に成形し、また、プログラム
情報中のコメント情報も、プログラムの仕様が視覚的に
容易に判別できる形態に成形し、さらにドキュメント中
に必要とするＳＳ情報を迅速に検索し得る目次、索引を
持つことで、コンピュータプログラムの保守作業の効率
を向上させることができる。

【００３２】また、本発明においては、プログラム情報
の解析情報を作成、保存するが、この情報はプログラム
情報中のキーワードの存在する位置を記録したものであ
るため、これを再利用することで、別のプログラム情報
のドキュメント化を行うことも容易である。

【図面の簡単な説明】

【図１】本発明の一実施例のシステム構成図である。

【図２】プログラム情報のドキュメント化の処理フロー
図である。

【図３】プログラム情報の階層構造の説明図である。

【図４】プログラム情報の具体例である。

【図５】図４のプログラム情報をドキュメント化した例
である。

【図６】ドキュメントの目次、索引の生成の説明図であ
る。

【符号の説明】

１０１　　キーボード １０２　　マウス １０３　　プログラム情報記憶装置 １０４　　データ処理装置 １０５　　制御手段 １０６　　プログラム情報編集手段 １０７　　プログラム情報ドキュメント化手段１０８　
　プログラム情報成形用バッファ１０９　　プログラム
情報解析手段 １１０　　プログラム情報出力手段 １１１　　解析情報記憶装置 １１２　　表示装置 １１３　　印刷装置

Claims (2)

【特許請求の範囲】
1. 【請求項１】　　所望プログラム言語の構文規則に従い
   構成したソースプログラム、及び、該ソースプログラム
   の機能単位に、その機能仕様をソースプログラム中に注
   釈として記述したコメント情報からなるプログラム情報
   を入力、編集して作成する手段と、該作成されたプログ
   ラム情報を記憶する手段と、該プログラム情報を表示、
   出力する手段とを備えてなるプログラム情報作成装置に
   おいて、前記作成されたプログラム情報に対して構文解
   析を行い、コメント及び制御構造のキーとなる部分を検
   出し、それを解析情報として記憶する手段と、前記解析
   情報をもとに当該プログラム情報を、そのプログラム仕
   様及び制御構造が視覚的に判別しやすい表現のドキュメ
   ントに成形する手段と、を設けたことを特徴とするプロ
   グラム情報のドキュメント化方式。
2. 【請求項２】　　前記ドキュメントを成形する手段では
   、プログラム情報のドキュメント化に加えて、当該ドキ
   ュメントの目次、索引も生成することを特徴とする請求
   項１記載のプログラム情報のドキュメント化方式。