JP2006277560A - ソフトウェア開発支援装置、設計文書生成プログラム及び設計文書生成方法 - Google Patents

Abstract

【課題】 ウォーターフォールモデルの手戻りコストを抑制して詳細設計工程とコーディング工程を平行で行うことが可能なソフトウェア開発支援装置を提供する。
【解決手段】 入力部１から受信したソースコードのファイルの拡張子により、プログラム言語を判定し、このソースコードを解析し、判定したプログラム言語に対応するＸＭＬ文書生成規則を、ＸＭＬ文書生成規則記憶手段３１から読み出し、解析したソースコードからＸＭＬ形式の文書（ドキュメント）を生成し、ＸＭＬファイル記憶手段３２に送信するＸＭＬ文書生成手段２１と、ＸＭＬファイル記憶手段３２にファイル化されて保存されているＸＭＬ形式の文書と、ＸＳＬＴファイル記憶手段３３に保存されているＸＳＬＴファイルとを読み込み、ＸＭＬ文書を変換することによって、所定のデザインを施したドキュメントを生成し、出力部４に送信するデザイン生成手段２２とを備える。
【選択図】図１

Description

本発明は、ソフトウェア開発に関し、特にソフトウェア開発におけるドキュメント生成の自動化を行うことが可能なソフトウェア開発支援装置、設計文書生成プログラム及び設計文書生成方法に関する。

従来、ソフトウェア開発において最も一般的に採用されている開発手法は、ウォーターフォールモデルである。ウォーターフォールモデルを基本とした開発手法では、基本設計工程、機能設計工程、詳細設計工程、コーディング工程、テスト工程という順番で開発を進めていく。この開発手法は、ソフトウェア開発のプロジェクトの初期段階で、プロジェクト全体の規模が見積もれるというメリットを有する。一方、この開発手法は、例えば、詳細設計工程で詳細設計が完了すると、コーディング工程でコーディング作業を始めるので、コーディング作業中に詳細設計の問題点や改善案などが見つかることが多くあるが、改善案を採用することなくコーディングを続行してしまうことがある。なぜならば、ウォーターフォールモデルは、工程が進んでしまうと、仕様漏れなど手戻りが必要になった時に大変なコストがかかるからである。

これに対し、近年登場してきた開発手法の例の１つとして、ＸＰ（ｅＸｔｒｅｍｅ Ｐｒｏｇｒａｍｍｉｎｇ）があげられる。ＸＰは、従来のウォーターフォールモデルによる開発手法と異なり、開発の初期段階の設計よりもコーディングとテストを重視しており、また、各工程を順序立てて順番に積み上げていくことよりも、常にフィードバックを行って修正及び再設計していくことを重視する開発手法である。また、従来必須だったドキュメントを重視しない。

このように、ソフトウェア開発における各工程においてフィードバックを行って修正及び再設計を可能とする従来の技術の１例が、特許文献1（特開２００２−３６６３５４号公報）に記載されている。特許文献1に記載の従来の技術は、ソフトウェア開発のコーディング工程等において、プログラムの変更理由やシステム構成さらには変更箇所等からなるソースプログラムの変更情報を改版プログラム仕様書として生成する。
特開２００２−３６６３５４号公報

上述した従来の開発手法であるＸＰは、以下に述べるような問題点が存在する。

第１に、ソフトウェア開発のプロジェクトの初期段階で、プロジェクト全体の規模が見積もれるというウォーターフォールが有するメリットを欠いている点である。

第２に、ドキュメントを用いないので、プロジェクト全体の規模が大きくなると、ミーティング、ソースコード及びペアプログラミングのみでは開発者間で情報を適切に共有することが難しい点である。特に、近年の開発体制の変革やビジネスのあり方を考えると、ソフトウェア開発の開発手法としてＸＰを採用することが現実的ではないケースが多い点である。

第３に、詳細設計工程のレベルでは、ソースコードの関数内の処理内容レベルも記載する必要があるが、特許文献1の例においては、ソースコードの関数内のコメントを抽出できない点である。また、このコメントを抽出するために、ソースコードの冒頭及び関数内の両方に関数内の処理内容レベルを記載することは、非効率である点である。さらに、特殊なフォーマットを用いて処理を行うので、汎用性がない点である。

本発明の目的は、ウォーターフォールモデルを採用しても、コストを抑制して容易に開発工程の手戻りを行えるソフトウェア開発支援装置、設計文書生成プログラム及び設計文書生成方法を提供することにある。

上記目的を達成するため本発明は、プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶する記憶手段と、入力されたソースコードを記憶手段の変換規則に基づいて変換することにより、ＸＭＬ形式のプログラムの設計文書を生成する生成手段とを備える構成としている。

本発明の好ましい態様では、上記態様に加え、ソースコードの各コード行の処理内容を識別する識別記号を各コード行に対応付ける変換規則によって、ソースコードをＸＭＬ形式の記述に変換する構成としている。

本発明のさらに好ましい態様では、上記態様に加え、ソースコードの関数内に記述されるコメント行の内容を関数と対応付けて識別する識別記号を各コメント行に対応付ける変換規則によって、ソースコードをＸＭＬ形式の記述に変換する構成としている。

本発明によれば、ウォーターフォールモデルを採用しても、工程の手戻りで生じるコストを抑制し、ソースコードの各行の記述を抽出し、設計文書を作成することが可能となる。

その理由は、プログラムの設計文書を自動的に生成するソフトウェア開発支援装置が、プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶する記憶手段と、入力されたソースコードを記憶手段の変換規則に基づいて変換することにより、ＸＭＬ形式のプログラムの設計文書を生成する生成手段とを備えるからである。

次に、本発明の実施の形態について図面を参照して詳細に説明する。

（ソフトウェア開発支援装置の構成）
図１を参照すると、本実施の形態によるソフトウェア開発支援装置は、キーボード等の入力部1と、プログラム制御により動作して入力部1から受信した情報に所定の処理をするＸＭＬ文書処理部２と、ＸＭＬ文書処理部２と情報の通信を行い、通信された情報を記憶する記憶部３と、ＸＭＬ文書処理部２から送信された情報を受信して出力するディスプレイ装置や印刷装置等の出力部４とを含む。

ＸＭＬ文書処理部２は、ＸＭＬ（ｅＸｔｅｎｓｉｂｌｅ Ｍａｒｋｕｐ Ｌａｎｇｕａｇｅ）文書生成手段２１と、デザイン生成手段２２とを備える。

ＸＭＬとは、文書やデータの意味や構造を記述するため、「タグ」と呼ばれる特定の文字列を埋め込んでいく言語である。

ＸＭＬ文書生成手段２１は、入力部１から受信した情報を構成するプログラムのソースコード中の文字列を、ＸＭＬ文書生成規則記憶手段３１（後述）に記憶されている所定の規則に従って、ＸＭＬ文書を構成する文字列に変換する機能を有する。

デザイン生成手段２２は、ＸＳＬＴ（Ｘｍｌ Ｓｔｙｌｅｓｈｅｅｔ Ｌａｎｇｕａｇｅ Ｔｒａｎｓｆｏｒｍａｔｉｏｎｓ）ファイル記憶手段３３（後述）に記憶されたフォーマットを利用して、ＸＭＬファイル記憶手段３２に記憶されているＸＭＬファイルを取得して、ＸＭＬファイル内のＸＭＬ文書の構造を別の形式に変形し、出力部４に出力する機能を有する。

記憶部３は、ＸＭＬ文書生成規則記憶手段３１と、ＸＭＬファイル記憶手段３２と、ＸＳＬＴファイル記憶手段３３とを備える。

ＸＭＬ文書生成規則記憶手段３１は、ＸＭＬ文書生成手段２１が、入力部１から受信した情報により構成されるプログラムを、ＸＭＬの技術を用いて、ＸＭＬ文書として生成するための所定の規則をあらかじめ記憶する機能を有する。

ＸＭＬファイル記憶手段３２は、ＸＭＬ文書生成手段２１によって生成されるＸＭＬ文書を、ファイル化して階層構造によりＸＭＬファイルとして記録する機能を有する。

ＸＳＬＴファイル記憶部３３は、ＸＭＬ文書を変形して様々なデザイン形式にするための複数のフォーマットを記憶する。

なお、ＸＳＬＴは、ＸＭＬによって記述された文書を他のＸＭＬ文書に変換するための簡易言語であって、ＸＭＬ文書の構造を別の形式に変形するための変換ルールが記述されている。

（ソフトウェア開発支援装置の動作）
次に、図１〜図５を参照して本実施の形態によるソフトウェア開発支援装置の動作について詳細に説明する。

図２は、本実施の形態によるソフトウェア開発支援装置の動作を示すフローチャートであり、図３〜図５は、本実施の形態によるソフトウェア開発支援装置で処理又は生成されるプログラムの表示形式を示す図である。

図１で示すように、ＸＭＬ文書処理部２は、入力部１から受信したプログラムのソースコードを、情報処理装置２のＸＭＬ文書生成手段２１に送信する。

なお、ソースコードは、プログラム言語で記述されたプログラムの設計図を示すものである。

ＸＭＬ文書生成手段２１は、入力部１から受信したプログラムのソースコードを格納するファイルの拡張子により、このソースコードに用いられたプログラム言語を判定する（図２，ステップＡ１）。

例えば、図３に示されるソースコードの拡張子は「．ｊａｖａ」（不図示）であるので、ＸＭＬ文書生成手段２１は、ステップＡ１で、このソースコードＪＡＶＡ（登録商標）言語であると判定手する。

次いで、ＸＭＬ文書生成手段２１は、ステップＡ１で判定したプログラム言語に基づいて、入力部１から受信したプログラムのソースコードを解析する（ステップＡ２）。

次いで、ＸＭＬ文書生成手段２１は、ステップＡ１で判定したプログラム言語に対応するＸＭＬ文書生成規則を、ＸＭＬ文書生成規則記憶手段３１から読み出す（ステップＡ３）。

次いで、ＸＭＬ文書生成手段２１は、ステップＡ３で読み出したＸＭＬ文書生成規則に従い、ステップＡ２で解析したソースコードからＸＭＬ形式の文書（ドキュメント）を生成する（ステップＡ４）。

なお、ＸＭＬ文書生成手段２１は、ソースコードの各コード行の直前の行に記されたコメント行を、各コード行のコメントと見なし、各コード行と、これに対応するコメントを結びつけてＸＭＬ文書を生成する。

例えば、ＸＭＬ文書生成手段２１は、ＸＭＬ文書生成規則に従い、図３に示されるように、コード行１０７である”ｃｌａｓｓ Ｅｍｐｌｏｙｅｅ”に対応するコメントとして、”ｃｌａｓｓ Ｅｍｐｌｏｙｅｅ”の直前の行１０６に記されたコメント行である”社員管理クラス”を結びつける。

そして、図４に示されるように、「Ｅｍｐｌｏｙｅｅクラス」（行２０９）と、「Ｅｍｐｌｏｙｅｅクラス」に結び付けられたコメント（行２１０、行２１２）として、”社員管理クラス”（行２１１）とが結び付けられ、ＸＭＬ文書として変換される。

なお、「Ｅｍｐｌｏｙｅｅクラス」の「クラス名」は、”Ｅｍｐｌｏｙｅｅ”（行２０９）である。

また、ＸＭＬ文書生成規則記憶手段３１に記憶された規則は、解析されたソースコードの構成要素ごとに対応して設定されている。

すなわち、図４に示されるように、解析された構成要素が「クラス」である場合には、「クラス」を構成要素として識別できる”ｃｌａｓｓ”（行２０９）というタグの後に「クラス名」である”Ｅｍｐｌｏｙｅｅ”（行２０９）を結び付け、その次の行（行２１０）に、「コメント」を構成要素として識別できる”ｃｏｍｍｅｎｔ”というタグを設け、さらにその次の行（行２１０）に、構成要素「クラス」に結び付けられた構成要素「コメント」である”社員管理クラス”（行２１１）が設けられる。

そして、さらにまた、その次の行（行２１２）に、構成要素「コメント」の記述を終了することを示すタグである”／ｃｏｍｍｅｎｔ”を結び付けて設ける。

次いで、ステップＡ４で生成されたＸＭＬ文書は、ＸＭＬファイル記憶手段３２にファイル化されて保存される（ステップＡ５）。

次いで、デザイン生成手段２２は、ＸＭＬファイル記憶手段３２にファイル化されて保存されているＸＭＬ文書と、ＸＳＬＴファイル記憶手段３３に保存されているＸＳＬＴファイルとを読み込む。

デザイン生成手段２２は、読み込んだＸＳＬＴファイルに基づいて、ＸＭＬ文書を変換することによって、所定のデザインを施したドキュメントを生成し、出力部４に送信する（ステップＡ６）。

例えば、デザイン生成手段２２が、図４に示すＸＭＬ文書を読み込んだ場合、図５に示すデザインを施したドキュメントを生成する。

例えば、図５を参照すると、図４の”ｃｌａｓｓ”（行２０９）、”／ｃｌａｓｓ”（行２３９）というタグに、”クラス１”（行３０４）及び”クラス名”（行３０５）を対応させている。

また、この”ｃｌａｓｓ”（行２０９）、”／ｃｌａｓｓ”（行２３９）というタグに結び付けられた”ｃｏｍｍｅｎｔ”（行２１０）、”／ｃｏｍｍｅｎｔ”（行２１２）というタグに、”説明”（行３０６）を対応させている。

図５に示すドキュメントの形式は、ＸＳＬＴファイルを他のＸＳＬＴファイルに切り替えることによって、容易に変更することができる。

以上のように、第１の実施の形態におけるＶＬＩＷ方式に基づくＳＩＭＤ型並列演算装置によれば、最大ｋ個の命令を同時に実行できるｋウェイＶＬＩＷ方式に基づくＰＥによって構成されたＰＥアレイを有するＳＩＭＤ型並列演算装置が元来備わるｋ命令分の命令流経路を、その本来の目的である同一命令流内で隣接して存在する並列処理可能な命令の同時実行（命令レベル並列性と呼ぶ）に利用するのみならず、命令レベル並列性が不足するケースでは、複数命令流の同時実行（命令流レベル並列性）の実現にも利用できるようにし、それによりＰＥアレイの実行性能を改善すること可能となる。

図６は、本発明の実施の形態によるソフトウェア開発支援装置上のコンピュータ処理装置４００のハードウェア構成を示すブロック図である。

コンピュータ処理装置４００は、ＣＰＵ４０１、メインメモリである主記憶部４０２、ネットワーク回線４と接続してデータの送受信を行う通信部４０３、ディスプレイやプリンタ等の表示部４０４、キーボードやマウス等の入力部４０５、周辺装置とデータの送受信を行うインタフェース部４０６、磁気ディスク、半導体メモリその他の記録媒体が挙げられる補助記憶部４０７とを備えている。

本実施の形態のソフトウェア開発支援装置は、その動作をハードウェア的に実現することは勿論として、上記した各手段、各プロセス等の各機能を実行するプログラムをコンピュータ処理装置のＣＰＵ４０１で実行することにより、ソフトウェア的に実現することができる。このプログラムは、補助記憶部４０７に格納され、その補助記憶部４０７から主記憶部４０２を介してＣＰＵ４０１にロードされ、その動作を制御することにより、上述した各機能を実現する。

このようにして、本発明のソフトウェア開発支援装置によれば、以下の効果を達成する。

第１の効果は、開発方法にウォーターフォールモデルを採用しても、工程の手戻りで生じるコストを抑制し、ソースコードの各行の記述を抽出し、設計文書を作成することが可能となる。従って、ソフトウェア開発のプロジェクトの初期段階で、プロジェクト全体の規模を見積もることができると共に、コストを抑制して工程の手戻りができる。

その理由は、プログラムの設計文書を自動的に生成するソフトウェア開発支援装置が、プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶するＸＭＬ文書生成規則記憶手段３１と、入力部１から入力されたソースコードをＸＭＬ文書生成規則記憶手段３１のＸＭＬ文書生成規則に基づいて変換することにより、ＸＭＬ形式のプログラムの設計文書を生成するＸＭＬ文書生成手段とを備えるからである。

第２の効果は、ＸＭＬ文書を生成するので、特殊なフォーマットを用いて処理を行うことなく、汎用的な端末で変換及び出力できることである。

第３の効果は、開発方法にＸＰ（ｅＸｔｒｅｍｅ Ｐｒｏｇｒａｍｍｉｎｇ）を採用しても、設計文書を生成するので、プロジェクト全体の規模が大きくなっても、開発者間で情報を適切に共有することができることである。

第４の効果は、ソースコードの関数内に記述されるコメント行の内容を関数と対応付けて識別する識別記号を、各コメント行に対応付けることでＸＭＬ形式の記述に変換するので、ソースコードの冒頭及び関数内の両方に関数内の処理内容レベルを記載しなくても、ソースコードの関数内のコメントを抽出できることである。

以上好ましい複数の実施の形態をあげて本発明を説明したが、本発明は必ずしも、上記実施の形態に限定されるものでなく、その技術的思想の範囲内において様々に変形して実施することができる。

本発明の実施の形態によるソフトウェア開発支援装置の構成を示すブロック図である。 本発明の実施の形態によるソフトウェア開発支援装置の動作を示すフローチャートである。 本発明の実施の形態によるソフトウェア開発支援装置で入力されるプログラムの１例である。 本発明の実施の形態によるソフトウェア開発支援装置で生成されるＸＭＬ文書の１例である。 本発明の実施の形態によるソフトウェア開発支援装置で出力される出力イメージの１例である。 本発明の実施の形態によるソフトウェア開発支援装置上のコンピュータ処理装置のハードウェア構成を示すブロック図である。

符号の説明

１：入力部
２：情報処理部
２１：ＸＭＬ文書生成手段
２２：デザイン生成手段
３：記憶部
３１：ＸＭＬ文書生成規則記憶手段
３２：ＸＭＬファイル記憶手段
３３：ＸＳＬＴファイル記憶手段
４：出力部
４００：コンピュータ処理装置
４０１：ＣＰＵ
４０２：主記憶部
４０３：通信部
４０４：表示部
４０５：入力部
４０６：インタフェース部
４０７：補助記憶部

Claims (18)

1. プログラムの設計文書を自動的に生成するソフトウェア開発支援装置であって、
   プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶する記憶手段と、
   入力された前記ソースコードを前記記憶手段の前記変換規則に基づいて変換することにより、前記ＸＭＬ形式の前記プログラムの設計文書を生成する生成手段とを備えることを特徴とするソフトウェア開発支援装置。
2. ＸＭＬ形式の前記設計文書の出力フォーマットを格納する出力フォーマット記憶手段を備え、
   前記生成したＸＭＬ形式文書を前記出力フォーマット記憶手段に格納される前記出力フォーマットで出力する手段を備えることを特徴とする請求項１に記載のソフトウェア開発支援装置。
3. 前記変換規則は、前記ソースコードの各コード行と、当該コード行の直前の行に記述されるコメント行との関連付けに基づいて前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１又は請求項２に記載のソフトウェア開発支援装置。
4. 前記変換規則は、前記ソースコードの各コード行の処理内容を識別する識別記号を、各コード行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１から請求項３の何れか１項に記載のソフトウェア開発支援装置。
5. 前記生成手段が、入力された前記ソースコードの各コード行毎に文字列を解析し、前記コード行毎に前記変換規則に基づいて前記ＸＭＬ形式の記述に変換することを特徴とする請求項１から請求項４の何れか１項に記載のソフトウェア開発支援装置。
6. 前記変換規則は、前記ソースコードの関数内に記述される前記コメント行の内容を前記関数と対応付けて識別する識別記号を、各コメント行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１から請求項５の何れか１項に記載のソフトウェア開発支援装置。
7. ソフトウェア開発においてコンピュータ処理装置上で実行され、プログラムの設計文書を自動的に生成する設計文書生成プログラムであって、
   前記コンピュータ処理装置に、
   プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶する記憶機能と、
   入力された前記ソースコードを前記記憶機能で記憶された前記変換規則に基づいて変換することにより、前記ＸＭＬ形式の前記プログラムの設計文書を生成する生成機能とを持たせることを特徴とする設計文書生成プログラム。
8. 前記コンピュータ処理装置に、
   ＸＭＬ形式の前記設計文書の出力フォーマットを格納する出力フォーマット記憶機能を持たせ、
   前記生成したＸＭＬ形式文書を前記出力フォーマット記憶機能で格納される前記出力フォーマットで出力する機能を備えることを特徴とする請求項７に記載の設計文書生成プログラム。
9. 前記変換規則は、前記ソースコードの各コード行と、当該コード行の直前の行に記述されるコメント行との関連付けに基づいて前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項７又は請求項８に記載の設計文書生成プログラム。
10. 前記変換規則は、前記ソースコードの各コード行の処理内容を識別する識別記号を、各コード行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項７から請求項９の何れか１項に記載の設計文書生成プログラム。
11. 前記生成機能で、入力された前記ソースコードの各コード行毎に文字列を解析し、前記コード行毎に前記変換規則に基づいて前記ＸＭＬ形式の記述に変換することを特徴とする請求項７から請求項１０の何れか１項に記載の設計文書生成プログラム。
12. 前記変換規則は、前記ソースコードの関数内に記述される前記コメント行の内容を前記関数と対応付けて識別する識別記号を、各コメント行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項７から請求項１１の何れか１項に記載の設計文書生成プログラム。
13. プログラムの設計文書を自動的に生成する設計文書生成方法あって、
    プログラムのソースコードの記述をＸＭＬ形式の記述に変換するための変換規則を記憶する記憶ステップと、
    入力された前記ソースコードを前記記憶ステップで記憶した前記変換規則に基づいて変換することにより、前記ＸＭＬ形式の前記プログラムの設計文書を生成する生成ステップとを備えることを特徴とする設計文書生成方法。
14. ＸＭＬ形式の前記設計文書の出力フォーマットを格納する出力フォーマット記憶ステップを備え、
    前記生成したＸＭＬ形式文書を前記出力フォーマット記憶ステップで格納する前記出力フォーマットで出力するステップを備えることを特徴とする請求項１３に記載の設計文書生成方法。
15. 前記変換規則は、前記ソースコードの各コード行と、当該コード行の直前の行に記述されるコメント行との関連付けに基づいて前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１３又は請求項１４に記載の設計文書生成方法。
16. 前記変換規則は、前記ソースコードの各コード行の処理内容を識別する識別記号を、各コード行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１３から請求項１５の何れか１項に記載の設計文書生成方法。
17. 前記生成ステップで、入力された前記ソースコードの各コード行毎に文字列を解析し、前記コード行毎に前記変換規則に基づいて前記ＸＭＬ形式の記述に変換することを特徴とする請求項１３から請求項１６の何れか１項に記載の設計文書生成方法。
18. 前記変換規則は、前記ソースコードの関数内に記述される前記コメント行の内容を前記関数と対応付けて識別する識別記号を、各コメント行に対応付けることで前記ＸＭＬ形式の記述に変換する規則を含むことを特徴とする請求項１３から請求項１７の何れか１項に設計文書生成方法。

Images