JP5197508B2

JP5197508B2 - ソースコード管理装置

Info

Publication number: JP5197508B2
Application number: JP2009151390A
Authority: JP
Inventors: 貴也菅ヶ谷
Original assignee: Mitsubishi Electric Corp
Current assignee: Mitsubishi Electric Corp
Priority date: 2009-06-25
Filing date: 2009-06-25
Publication date: 2013-05-15
Anticipated expiration: 2029-06-25
Also published as: JP2011008535A

Description

本発明は、ソースコードの閲覧機能を有し、また、閲覧中のソースコードに関連する情報を取得および表示するソースコード管理装置に関する。

従来のテキストベースのソースコード入力（および閲覧）機能を有する装置においては、ソースコード中の位置をソースコードに関連する情報とともに管理することはほとんど行われておらず、管理していた場合も、関連する情報からソースコードを生成するような利用方法に限られていた（例えば、特許文献１参照）。

特開２００７−９４４５３号公報（第１頁解決手段、図２）

このような従来方式では、たとえばハードウェア記述言語を用いた設計において、ソースコードの関連情報として設計根拠等をソースコード中に入力したい場合、ソースコードのコメント文として入力する必要がある。しかしながら、テキスト入力のため表現に自由度がなく、また、入力する情報量（テキスト）が多くなると、ソースコードの解読性が下がる、という問題があった。

また、関連情報が常に表示されるため、体裁を考慮しなければならず、「根拠不明のまま流用」、「仮決定値」というような、コードレビュー、流用設計時に重要となるコメントは入力しづらいという問題もあった。

本発明は、上記に鑑みてなされたものであって、ソースコードの関連情報を必要に応じて効率よく入力／参照可能なソースコード管理装置を得ることを目的とする。

上述した課題を解決し、目的を達成するために、本発明は、記憶部に格納されたソースコードを表示してユーザに閲覧させるソースコード管理装置であって、前記ソースコードに関連する情報（関連情報）をユーザから取得した場合に、当該関連情報の入力操作でユーザに使用されたカーソルが前記ソースコードのどこを指していたかを示す情報である位置情報、および取得した関連情報に基づいて、当該関連情報と前記ソースコードとの関係を示した関連情報定義ファイルを生成する定義ファイル生成手段と、前記ソースコードの表示中に、ユーザに操作されているカーソルが当該ソースコードのどこを指しているかを判定する位置判定手段と、前記位置判定手段による判定結果および前記定義ファイル生成手段により生成された関連情報定義ファイルに基づいて、当該判定結果が示す位置に対応した関連情報が存在するかどうかを判定し、その結果を表示画面に出力する表示制御手段と、を備えることを特徴とする。

この発明によれば、ソースコードの位置と関連情報に基づいて、これらの関係を示す関連情報定義ファイルを生成し、また、カーソルが示すソースコードの位置と関連情報定義ファイルに基づいて、カーソルが示している位置に対応する関連情報の有無を判定することとしたので、ソースコードの関連情報を必要に応じて効率よく参照できる、という効果を奏する。

以下に、本発明にかかるソースコード管理装置の実施の形態を図面に基づいて詳細に説明する。なお、この実施の形態によりこの発明が限定されるものではない。

実施の形態１．
図１は、本発明にかかるソースコード管理装置の実施の形態１の構成例を示す図である。このソースコード管理装置は、制御部１および記憶部２を備え、制御部１は、関連情報取得部１１、定義ファイル生成部１２、位置判定部１３および表示制御部１４により構成される。また、記憶部２は、ソースコードファイル２１、関連情報定義ファイル２２および関連情報ファイル２３を保持している。

本実施の形態のソースコード管理装置において、制御部１は、ユーザにより生成／更新されたソースコードを取得した場合、それをソースコードファイル２１として記憶部２へ格納する。また、ソースコードの生成や更新、閲覧作業において、表示中のソースコードに関する関連情報を取得した場合、関連情報定義を生成し、それを関連情報定義ファイル２２として記憶部２へ格納する。また、取得した関連情報については、関連情報ファイル２３として記憶部２へ格納する。さらに、表示中のソースコードに関する関連情報が記憶部２で保持されている状態においては、保持されている関連情報の存在を外部（ユーザ）に通知する必要があるかどうかを判断し、必要と判断した場合には関連情報の存在を通知する。記憶部２は、制御部１から各種データ（ファイル）を受け取った場合、それを所定の記憶領域に格納して保持しておく。

制御部１の各構成要素の動作について説明する。制御部１において、関連情報取得部１１は、図示を省略した表示部へソースコードが表示された状態において、表示中のソースコードについての関連情報入力操作がユーザにより行われた場合、入力された関連情報を取得する。また、取得した関連情報を定義ファイル生成部１２に対して出力する。ここで、関連情報とは、たとえばソースコード中の信号名やコメントなどである。ただし、その種別を限定するものではなく、ソースコードに対応付けて管理させる必要があるとユーザが判断し、入力した情報である。

定義ファイル生成部１２は、関連情報取得部１１から関連情報を受け取った場合、その時点のカーソルが、表示されているソースコードのどこを指しているか（カーソル位置）を検出し、検出したカーソル位置の情報と受け取った関連情報とに基づいて関連情報定義ファイルを生成する。たとえば、カーソル位置情報と関連情報との対応関係を示す情報を関連情報定義ファイルとして生成する。また、生成した関連情報定義ファイルと関連情報取得部１１から受け取った関連情報とを記憶部２の所定の記憶領域へ格納する。なお、カーソル位置の検出は、定義ファイル生成部１２ではなく関連情報取得部１１が行ってもよい。この場合、関連情報取得部１１は、関連情報とともにカーソル位置情報を定義ファイル生成部１２に渡す。

位置判定部１３は、ソースコードが表示された状態において、カーソルの位置（表示されているソースコードのどこをカーソルが指しているか）を判定し、判定結果（カーソル位置検出結果）を表示制御部１４に対して出力する。

表示制御部１４は、カーソル位置判定結果を位置判定部１３から受け取った場合、この情報と記憶部２が保持している関連情報定義ファイル２２とに基づいて、ユーザが参照を望んでいる可能性のある関連情報が記憶部２で保持されているかどうかを判定する。また、保持されていると判定した場合には、関連情報の存在を通知（表示）する。

図２は、本発明にかかるソースコード管理装置においてソースコード閲覧中に関連情報を参照する場合のイメージを示した図である。

図２では、ソースコードファイル２１の内容を表示するソースコード表示画面３において、関連情報定義が登録されているソースコード位置の上にカーソル４が来ると、関連情報確認メニュー５（“関連情報有”の文字列）が表示され、マウスクリックなどの選択指示により、関連情報ファイル２３が関連情報表示画面６に表示されることで、関連情報を確認する様子を示している。ソースコード表示画面３と関連情報表示画面６はいずれか一方を排他的に表示するようにしてもよいし、これらを並べて同時に表示するようにしてもよい。また、これらの一部を重ねて同時に表示するようにしてもよい。

ここで、ユーザがソースコード管理装置に対して関連情報を登録する場合（ソースコード管理装置がユーザから関連情報を取得する場合）の動作について説明する。図３は、ソースコード中の所望の位置に対応させて関連情報（信号名やコメント等）を入力する場合の動作を示した図である。

図示したように、ソースコード管理装置は、ソースコード表示画面３を表示させた状態において、カーソル４などにより任意の関連情報登録位置がユーザにより選択されると、関連情報入力確認メニュー７（“関連情報入力？”の文字列）を表示する。そして、関連情報の入力開始が指示された場合、さらに、関連情報入力支援画面８が表示される。なお、図３の例では、関連情報入力支援画面８を階層的に表示する様子を示している。すなわち、関連情報入力支援画面８として、まず、「カウンタ」、「タイマ」または「その他」を選択するための画面をまず表示し、そこでの選択結果に応じて次の関連情報入力支援画面８（この例では「タイマ」が選択された場合の画面）を表示する様子を示している。

関連情報入力支援画面８での入力（数値、コメントなどの入力）が終了すると、上述したように、入力された関連情報は関連情報取得部１１を介して定義ファイル生成部１２へ渡され、定義ファイル生成部１２は、定義情報を生成する。このような関連情報入力支援画面８を用意することにより、ユーザは、ソースコード中のキーワード等と関連情報との対応を効率よく定義することが可能となる。

つづいて、本実施の形態のソースコード管理装置において、ソースコード表示画面３での操作実行から関連情報表示画面６が表示されるまでの処理の流れを図４のフローチャートに基づいて説明する。なお、図４は、参照情報表示処理手順の一例を示したフローチャートである。

ソースコード表示画面３を表示している場合、ソースコード管理装置においては、まず、カーソルの位置判定を行う（ステップＳ１）。具体的には、位置判定部１３が、カーソルが表示中のソースコードのどこを指しているのかを判定する。

カーソル位置の判定が終了すると、次に、判定結果に対応する関連情報が登録されているかどうかを表示制御部１４が判断する（ステップＳ２）。具体的には、表示制御部１４は、記憶部２で保持されている関連情報定義ファイル２２を確認し、カーソル位置判定結果が示すソースコード上の位置に対応する関連情報を記憶部２が保持しているかどうかを判定する。そして、対応する関連情報を記憶部２が保持している場合（ステップＳ２，Ｙｅｓ）、その旨（カーソル位置に対応する関連情報が存在する旨、図２の「関連情報確認メニュー５」参照）をソースコード表示画面３内で表示する（ステップＳ３）。一方、対応する関連情報を記憶部２が保持していないと判断した場合には（ステップＳ２，Ｎｏ）、ステップＳ１に戻り動作を継続する。

ステップＳ３を実行すると、表示制御部１４は、次に、ユーザから関連情報を表示するように指示されたかどうかを監視する（ステップＳ４）。そして、表示指示が行われていないと判定した場合（ステップＳ４，Ｎｏ）、さらに、カーソルの移動操作が行われたかどうかを監視し（ステップＳ６）、移動操作を検出した場合には（ステップＳ６，Ｙｅｓ）、ステップＳ１に戻り動作を継続する。なお、ステップＳ１に戻る場合、上記ステップＳ３で表示させた「関連情報が存在する旨の表示」をクリアする。移動操作を検出しなかった場合（ステップＳ６，Ｎｏ）、ステップＳ４に戻り動作を継続する。

また、表示指示が行われていると判定した場合（ステップＳ４，Ｙｅｓ）、関連情報表示画面６（図２参照）を表示する（ステップＳ５）。すなわち、表示制御部１４は、上記ステップＳ１でのカーソル位置判定結果に対応する関連情報を記憶部２から読み出し、読み出した関連情報に応じた内容の関連情報表示画面６を表示部に表示させる。

このように、本実施の形態のソースコード管理装置は、ソースコードの関連情報を、当該情報を取得した際のカーソルの位置（関連情報を入力する際にソースコードのどこをユーザが指定したのかを示す情報）と対応付けて管理しておき、また、カーソル位置の検出結果に基づいて、その時点でユーザが確認する可能性のある関連情報が存在するかどうかを判定し、関連情報が存在する場合にはその旨を通知することとした。また、この通知を行っている状態でユーザが所定の操作を行った場合に、対応する関連情報を表示することとした。これにより、ユーザは、ソースコードの関連情報を必要に応じて効率よく参照することが可能になる。

実施の形態２．
つづいて、実施の形態２のソースコード管理装置について説明する。なお、ソースコード管理装置の構成は実施の形態１のソースコード管理装置と同様である、ただし、動作については一部異なる。

図５は、実施の形態２のソースコード管理装置の動作例を示した図であり、機能解析（仕様理解）やソースコードレビュー等の参照用途により、ソースコード中の信号名やコメント等の関連情報登録位置から、関連情報を選択参照する場合のイメージを示している。

図５の動作を実現するために、本実施の形態のソースコード管理装置は、ユーザが参照用途を予め指定するための機能を具備する。そして、この機能を利用した参照用途の指定が完了している状態では、図５に示したような動作を行う。たとえば、機能解析作業において関連情報を表示するように指示された場合、機能解析作業で必要な関連情報９−１を表示する。また、ソースコード改修作業において関連情報を表示するように指示された場合、ソースコード改修作業で必要な関連情報９−２を表示する。なお、仮に、同じ位置（位置Ａとする）を指定して機能解析作業で必要な関連情報（関連情報＃１とする）の登録とソースコード改修作業で必要な関連情報（関連情報＃２とする）が登録されていた場合、本実施の形態のソースコード管理装置は、ユーザが機能解析作業を行っている状態において、位置Ａにて関連情報を表示するように指示されると関連情報＃１を表示する。また、ユーザがソースコード改修作業を行っている状態において、位置Ａにて関連情報を表示するように指示されると関連情報＃２を表示する。

このような機能を実現するため、たとえば、本実施の形態の関連情報取得部１１は、関連情報を取得する際に、取得した関連情報がどの作業時に参照すべきかを示す情報（参照用途情報とする）を併せて取得し、定義ファイル生成部１２は、取得された関連情報および参照用途情報と、これらを取得した際のカーソル位置とを対応付けて関連情報定義を生成する。また、表示制御部１４は、カーソル位置判定結果が示すソースコード上の位置に対応する関連情報を記憶部２が保持しているかどうかの判定処理では、ユーザがその時点で実施している作業が何かを参照し、参照結果と関連情報定義ファイル２２に基づいて、判定を行う。

このように、本実施の形態のソースコード管理装置では、関連情報が存在するかどうかを判定する際に、その時点で実施されている作業内容も考慮して判定を行うこととした。これにより、仕様理解やソースコードレビューなど、作業目的に応じた関連情報のみを確認できるようになり、各作業を効率よく行うことが可能となる。

なお、上述した各実施の形態では、カーソルとマウスクリックを利用するユーザインタフェースの場合の例を示したが、その他のキーボードや音声入力等のユーザインタフェースを利用する場合にも適用可能であり、同様の効果を得ることができる。また、関連情報登録位置をカーソル位置で示すこととして説明を行ったが、キーワードや複数行等の単位で登録するようにしてもよく、この場合にも同様の効果を得ることができる。

以上のように、本発明にかかるソースコード管理装置は、ソースコード管理に有用であり、特に、ソースコードの関連情報を効率的に参照させることが可能なソースコード管理装置に適している。

本発明にかかるソースコード管理装置の実施の形態１の構成例を示す図である。本発明にかかるソースコード管理装置においてソースコード閲覧中に関連情報を参照する場合のイメージを示した図である。ソースコード中の所望の位置に対応させて関連情報（信号名やコメント等）を入力する場合の動作を示した図である。参照情報表示処理手順の一例を示したフローチャートである。実施の形態２のソースコード管理装置の動作例を示した図である。

１制御部
２記憶部
１１関連情報取得部
１２定義ファイル生成部
１３位置判定部
１４表示制御部
２１ソースコードファイル
２２関連情報定義ファイル
２３関連情報ファイル

Claims

記憶部に格納されたソースコードを表示してユーザに閲覧させるソースコード管理装置であって、
前記ソースコードに関連する情報（関連情報）をユーザから取得した場合に、当該関連情報の入力操作でユーザに使用されたカーソルが前記ソースコードのどこを指していたかを示す情報である位置情報、および取得した関連情報に基づいて、当該関連情報と前記ソースコードとの関係を示した関連情報定義ファイルを生成する定義ファイル生成手段と、
前記ソースコードの表示中に、ユーザに操作されているカーソルが移動したことを検出するごとに、移動後のカーソルが当該ソースコードのどこを指しているかを判定する位置判定手段と、
前記位置判定手段が前記判定を行うごとに、前記位置判定手段による判定結果および前記定義ファイル生成手段により生成された関連情報定義ファイルに基づいて、当該判定結果が示す位置に対応した関連情報が存在するかどうかを判定し、関連情報が存在する場合にはその旨を示す表示を表示画面に出力する表示制御手段と、
を備えることを特徴とするソースコード管理装置。
記憶部に格納されたソースコードを表示してユーザに閲覧させるソースコード管理装置であって、
前記ソースコードに関連する情報（関連情報）および当該関連情報を利用する作業の種別情報をユーザから取得した場合に、当該関連情報および種別情報の入力操作でユーザに使用されたカーソルが前記ソースコードのどこを指していたかを示す情報である位置情報、および取得した関連情報に基づいて、当該関連情報および種別情報と前記ソースコードとの関係を示した関連情報定義ファイルを生成する定義ファイル生成手段と、
前記ソースコードの表示中に、ユーザに操作されているカーソルが移動したことを検出するごとに、移動後のカーソルが当該ソースコードのどこを指しているかを判定する位置判定手段と、
前記位置判定手段が前記判定を行うごとに、前記位置判定手段による判定結果、前記定義ファイル生成手段により生成された関連情報定義ファイル、およびユーザが実行中の作業内容に基づいて、当該判定結果が示す位置に対応した関連情報が存在するかどうかを判定し、関連情報が存在する場合にはその旨を示す表示を表示画面に出力する表示制御手段と、
を備えることを特徴とするソースコード管理装置。