SE | × | PE | ○ | EE | ○ | VE | × |
リバースエンジニアリングは Doxygen というソフトを使用しています。
Doxygenの設定方法と、リバースエンジニアリングの実行方法について説明します。
1.Doxygeの最新版を取得
「http://www.doxygen.org/」からDoxygeの最新版を取得してください。
最後にテストした際の Doxygen のバージョンは 1.5.2 を使用しました。
2.Doxygenのインストール
Doxygenを任意のフォルダにインストールして下さい。
デフォルトのインストール先は「C:\Program Files\doxygen」です。
3.1st Modellerに登録
![]()
「ツール(T)」-「環境オプション(O)」を選択し、「リバースエンジニアリング」のタブをクリックします。
「Doxygen実行ファイル」に、先ほどインストールしたDoxygenのフォルダを指定します。Doxygenをインストーラからインストールしている場合は「自動取得を試みる」のボタンを使用することでDoxygenの実行ファイルパスを自動取得することも可能です。
デフォルトの場合は「C:\Program Files\doxygen\bin\doxygen.exe」です。
設定が完了しましたら、「OK」ボタンを押下して下さい。
1.リバースエンジニアリングの前準備
まずは、プロジェクトを作成しておきます。
そのプロジェクトには少なくともリバースエンジニアリング実行時の登録先となるクラス・ディクショナリと関連・ディクショナリをを作成しておきます。
プロジェクトツリービュー上のクラス・ディクショナリをダブルクリックして、クラス・ディクショナリウインドウを表示します。
メインメニューに、「クラス・ディクショナリ(D)」が表示されますので、「クラス・ディクショナリ(D)」-「クラス・ディクショナリのオプション設定(O)」を選択します。 画面が立ち上がるので、「リバースエンジニアリング」タブを選択して下さい。
2.リバースエンジニアリングの対象登録
![]()
「設定ファイル自動生成情報」にて、リバースエンジニアリング対象となるファイル、またはディレクトリを指定します。 ディレクトリを指定した場合は、その配下のディレクトリもリバースエンジニアリング対象になります。
設定が完了しましたら、「OK」ボタンを押下して下さい。
3.リバースエンジニアリングの実行
メニューから「クラス・ディクショナリ(D)」-「リバースエンジニアリングの実行(O)」を選択します。下記の画面が表示されます。
![]()
まず、関連・ディクショナリを選択します。プロジェクト内に関連・ディクショナリが1つも存在しない場合は1つ以上の関連・ディクショナリを作成してから当画面を開いてください。
「実行(E)」を押下する事で、さきほど設定したファイル、またはディレクトリに対して、リバースエンジニアリングを実行します。 「閉じる」ボタンを押下するとリバースエンジニアリングの結果をクラス・ディクショナリと関連・ディクショナリに登録します。
リバースエンジニアリングの結果を取りやめることは出来ませんが、アンドゥすることで元に戻すことは出来ます。
注意:クラスおよび関連・ディクショナリに既にデータがある場合は、削除したのちにリバースエンジニアリング結果を格納します。 リバースエンジニアリングするソースのディクショナリと独自に追加するデータとはディクショナリを分けることをお勧めします。
処理経過およびエラー発生の見分け方
Doxygen の実行状況は上記ダイアログ画面の「Doxygen実行ログ」で確認できます。処理が進むにつれて、様々な情報が書き出されていきます。内容を理解する必要は無く、処理が進んでいることを確認する為だけに表示している情報です。
リバースエンジニアリングの完了は「処理状況」ログで確認できます。また、実行ボタンと閉じるボタンの無効化が解除されたことでも確認できます。
「Doxygen実行ログ(警告・エラー)」というタブがあり、そこに表示されている情報はDoxygenが出力した 「警告情報」または「エラー情報」になります。エラーメッセージは英語ですが読んでいただければ、警告なのかエラーなのかはわかると思います。また、ソース中に書かれているJavaDocタイプまたはDoxygenタイプの制御情報に何らかの間違いがある場合は、このタブの中に警告情報として出力されます。
現バージョンの制約
Doxygenの制約で「日本語ファイル名を含む、ファイルやフォルダ」は処理できません。 必ず半角英数字だけで構成されているファイルやフォルダに対してのみ、リバースエンジニアリング機能を使用してください。
日本語名を使用したディレクトリ名やファイル名があった場合は、上記の「警告・エラー」の画面に ファイルが読み込めなかった旨をエラーメッセージとして表示します。