改定履歴
|
版 |
改定日 |
改定者 |
改定内容 |
|
1.0.0 |
2014/06/016 |
T.I |
新規作成 |
|
|
|
|
|
|
|
|
|
|
1 アプリケーションの概要
このアプリケーションはソースコードにドキシジェンで読み込むことのできるコメントをユーザの好みに合わせて挿入できるアプリケーションである。ファイル単体はもちろん、ディレクトリ内にあるすべての対象ファイルにコメントを挿入できることができる。
2 アプリケーション機能説明
2.1 メイン画面
以下に本アプリケーションの画面と使用する機能の一覧をまとめる。
図 1 アプリケーションメイン画面
<アプリケーション画面説明>
2.1.1 機能① （ソースコード種類選択コンボボックス）
図 2 ソースファイル設定画面
コメントを自動生成するソースファイルを指定する。
また、ソースファイルの指定方法として以下の選択ができる。
ž ソースファイル
対象のファイルは*.c、*.cpp、*.hである
ž フォルダ
指定されたフォルダ内に含まれるすべてのソースファイルをコメント自動生成の対象とする。
ž VCproject
プロジェクトファイルはVisualStudio2008で生成されているプロジェクトである。指定されたプロジェクトファイル内に存在する、*.c、*.cpp、*.hファイルをすべて対象とする。
2.1.2 機能② （ソースパス表示画面）
図 3 ファイルパス表示
後述の選択ボタンで選択したソースファイルまたは、フォルダのパスを表示する。この表示画面は直接ソースファイルまたは、フォルダのパスを書き込むことも可能である。
2.1.3 機能③ （ソースコード選択ボタン）
図 4 ソースファイル選択画面
ソースコード選択ボタンを押すことで、コメント自動生成を行うソースファイル、またはソースフォルダを選択することのできるダイアログが表示される。
そのダイアログ内でコメントを挿入したいファイルまたは、フォルダを選択する（選択できるファイルは特定の拡張子、*.c、*.cpp、*.h、*.vcprojのファイルだけである）。選択が完了すると、前述で説明したソースパス表示画面に選択したソースファイルまたは、フォルダのパスが表示される。
2.1.4 機能④ （エンコード設定ボタン）
図 5 エンコード設定ボタン
読み込まれる自動生成対象のソースファイルのエンコードを以下のいずれかから選択する。また、ここで選択されたエンコードで、自動生成を行ったソースファイルも出力される。
ž UTF-8
ž Shift-JIS
2.1.5 機能⑤ （スタイル設定ボタン）
図 6 スタイル設定ボタン
コメント自動生成時のスタイルとして、以下のいずれかを選択する。（スタイルについては2.3.1で説明）
ž Javadocスタイル
ž Qtスタイル
2.1.6 機能⑥ （既存コメント処理設定画面）
図 7 既存コメントに対しての処理画面
「上書き」が選択されている場合、前述で説明したスタイル設定の項目に従って、ソースコード内の選択されたスタイル以外のコメントはすべて削除し、コメントを挿入する。
「下に挿入」が選択されている場合、ソースコード内の既存のコメントはすべて残し、前述で説明したスタイル設定で選択されたスタイルで、新たにコメントを挿入する。
2.1.7 機能⑦ （挿入コメント位置設定画面）
図 8 コメント位置設定画面
本アプリケーションでは、以下の項目に対して、コメントの自動生成を行う。
ž ファイル定義
ž クラス定義
ž 関数定義
ž #define
ž 構造体定義
ž 共用体定義
ž 列挙型定義
ž グローバル変数
各項目のコメント自動生成に対し、以下の項目のどちらかを選択する
ž 宣言位置の1行上にコメントを生成する。
ž 宣言位置の横にコメントを生成する。
2.1.8 機能⑧ （バックアップ設定チェックボックス）
図 9 バックアップ選択画面
バックアップを取るかどうかを設定するチェックボックスである。チェックボックスにチェックが付いている場合は直接ファイルパス入力も可能である。チェックボックスにチェックが入っていない場合フォルダ選択ボタンとバックアップフォルダパス表示画面ほ操作できない。
2.1.9 機能⑨ （バックアップフォルダパス表示画面）
図 10 バックアップパス表示画面
指定したバックアップを保存するフォルダのパスを表示する。
前述で説明したバックアップ設定チェックボックスにチェックが付いている場合、後述で説明するバックアップフォルダ選択ボタンで選択されたフォルダのパスが表示される（バックアップフォルダ表示エディットボックスに直接パスを入力可能）。しかし、バックアップ設定テックボックスにチェックが付いていない場合は、フォルダパスが表示されていても、それらは有効ではない。
2.1.10 機能⑩ （バックアップフォルダ選択ボタン）
図 11 バックアップフォルダ選択画面
前述で説明したバックアップ設定チェックボックスにチェックが入っている場合、バックアップフォルダ選択ボタンを押すことが可能である。バックアップフォルダ選択ボタンを押すと、フォルダーを選択するダイアログが表示される。
そのダイアログでバックアップを保存するフォルダを選択する。選択されたフォルダには、コメントを自動生成する前のファイルが保存される。選択したフォルダのパスは前述で説明したバックアップフォルダ表示エディットボックスに表示される。
2.1.11 機能⑪ （設定保存ボタン）
図 12 設定保存画面
設定保存ボタンを押すと設定を保存するフォルダを選択するダイアログが表示される。そのダイアログで選択したフォルダに、その時点で項目に設定されている値をアプリケーション専用のファイルとして保存する。
2.1.12 機能⑫ （設定読み込みボタン）
図 13 設定の読み込み画面
設定読み込みボタンを押すと、ファイル検索ダイアログが表示される。そのダイアログで、設定を保存されているアプリケーション専用のファイルを選択することで、以前の設定した値を読み込むことができる。設定を読み込むことで、設定項目を保存された時と同じ値に変更する。
2.1.13 機能⑬ （実行ボタン）
図 14 実行ボタン
設定項目に従って、コメントを挿入したファイルを出力する実行ボタン。このボタンを押すとコメント自動生成の処理が始まり、進行状況を確認することができる別ウィンドウ（2.2で説明）が表示される。
2.2 進行状況画面
以下にコメント自動生成処理を行っている際に表示される進行状況画面についての説明を記載する。
図 15 進行状況画面ダイアログ
|
番号 |
項目名称 |
参照 |
|
⑭ |
進捗状況表示プログレスバー |
2.2.1 |
|
⑮ |
進捗状況表示テキストエディタ |
2.2.2 |
|
⑯ |
キャンセルボタン |
2.2.3 |
2.2.1 機能⑭ （進捗表示バー）
図 16 進捗表示バー
コメント自動生成が行われているファイル数により、進捗状況表示プログレスバーが変化する。コメントの自動生成がすべて終了すると自動的に進行状況確認ダイアログは終了する。
2.2.2 機能⑮ （進捗表示）
図 17 進捗表示
処理の進捗に伴い0～100％で表示される。コメント自動生成を行う総ファイル数と、コメント自動生成が終了したファイルの割合によって値は変化する。コメント自動生成が終了したファイルが多いほど100%に近づいていく。
2.2.3 機能⑯ （キャンセルボタン）
図 18 キャンセルボタン
キャンセルボタンを押すことで、コメント自動生成処理を中断し、設定画面まで戻る。処理中のファイルは、処理が行われたところまでをファイルに反映し、選択したフォルダに出力される。
2.3 コメント自動生成処理に関する説明
2.3.1 スタイルの説明
コメント自動生成時のスタイルとして、以下のいずれかを選択可能とする。
ž Javadocスタイル
複数行にわたってコメントを生成する場合
/**
... text ...
*/
一行にコメントを生成する場合
/**< 詳細説明 . 詳細が続く. */
ž Qtスタイル
複数行にわたってコメントを生成する
/*!
... text...
*/
一行にコメントを生成する場合
/*!< メンバーの後ろに詳細説明 */
2.3.2 スタイルについて
本アプリケーションでは、以下の項目に対して、コメントの自動生成を行う。
ž ファイル定義(2.3.2.1)
ž クラス定義(2.3.2.2)
ž 関数定義(2.3.2.3)
ž #define(2.3.2.4)
ž 構造体定義(2.3.2.5)
ž 共用体定義(2.3.2.6)
ž 列挙型定義(2.3.2.7)
ž グローバル変数(2.3.2.8)
どのようなコメントが生成されるかは、以下に記載する。
2.3.2.1 ファイル定義
/*! @file ファイル名
@brief
@author */
2.3.2.2 クラス定義
/*! @class クラス名
@brief */
2.3.2.3 関数定義
/*! @fn ファイル名
@brief
@param[in,out] 変数名
@return 戻り値*/
2.3.2.4 #define
/*! @def define名
@brief */
2.3.2.5 構造体定義
/*! @struct _tConf
@brief */
2.3.2.6 共用体定義
/*! @union a
@brief */
2.3.2.7 列挙型定義
/*! @enum 列挙型名
@brief */
2.3.2.8 グローバル変数
/*! @var グローバル変数名
@brief */
2.3.3 ログファイルについて
ログファイルはコメント自動生成を行った際、自動的に出力されるテキストファイルである。ログファイルの出力先は、コメント自動生成を行うファイルを選択したフォルダと同じである。
記載内容はコメント自動生成開始日時、終了日時、コメント自動生成を行った総ファイル数が基本的には記載される。また、コメント自動生成中にエラーで処理が中断された場合、このログファイルに、どのファイルがどのようなエラーで処理が中断されたかが記載される。