□□□□□□□□□□□□□□□□□□□□□□□□□□□□□
□□
□□ C/C++関数ヘッダ自動生成・メンテナンスツール
□□ 「関数ヘッダメーカー V1.0」公開のお知らせ
□□
□□□□□□□□□□□□□□□□□□□□□□□□□□□□□□□□
┃§１ β版での要望を反映
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
関数ヘッダメーカーは 本年 4月にβ版を配布し、たくさんの方にご
試用いただきました。その折、試用者の方々からあげられた要望を
今回リリースする V1.0 に取り入れ、更に実用的になりました。
主な改善点を以下に記します。
① .c .cpp ファイルの関数定義からだけでなく、プロトタイプ宣言か
らも関数ヘッダの雛形を作成できるようになりました。
② 関数ヘッダ中の関数名タイトルの部分の修飾の種類が増えました。
③ プレビューウィンドウの大きさを変えられるようになりました。
④ 255バイト以上のコメントを入力できるようになりました。
⑤ 表示に使用するフォームの切り替えが【表示】メニューの直下から
できるようになりました。
┃§２ 関数ヘッダメーカーとは？
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
近年、Microsoft(R) Visual Studio .NET に代表されるような強力な
開発環境を使用して、効率的にプログラム開発を行えるようになりまし
た。ところが、ツールが強力過ぎるあまり、コメントの挿入などの「ソ
フトウェアの保守・メンテナンスに必要な作業」が「コーディングのス
ピード」に追いつかないという問題を生じるようになりました。
「納期に追われ、開発環境の機能・パワーに頼り、山のように追加して
しまった関数やメソッドの仕様書・コメントをどうしよう！」
どの開発者の方もこんな経験を一度はお持ちではないでしょうか。そん
な時には関数ヘッダメーカーがお役に立ちます。
関数ヘッダメーカーは C/C++ の関数に関するドキュメントを自動生成
・メンテナンスする開発支援ツールです。ソースコードを解析して関数
ヘッダの雛形を自動生成し、それにコメントを追加して関数ヘッダを完
成させるまでを支援します。同じ作業を手動で行う場合に比べ、開発者
の負担を大幅に軽減することができます。
あらかじめ、所定の位置にコメントが記されているソースコードであ
れば、自動生成した雛形だけでも、十分実用的な関数ヘッダができあが
ります。
コメントがあまりないソースコードでも、以下の機能により、コメン
トの入力作業を効率的に行うことができます。
① 充実したテキスト処理機能を備えています。コメント入力の際には
１段落をベタ書きで入力すれば「テキスト折り返しのための改行の
挿入」や「インデントのための行頭の空白の挿入」は自動的に行い
ます。また、箇条書きや罫線画といった書式も処理します。
② コメントの自動補填機能を備えています。以前入力した（または解
析の際に検出した）「パラメータ」「戻り値」等のコメントを記憶
し、同じ名前のものを再度入力（検出）した場合には、記憶されて
いるコメントを自動的に補填します。
また、「ソースコードに埋め込まれているヘッダを再編集する機能」
や「ソースコードの更新をヘッダに反映する機能」等を備え、関数ヘッ
ダをメンテナンスする機能も充実しています。
その他、既存の関数ヘッダ作成ツールにはない、次のような機能を実
装しています。
① 「.c .cpp ファイルの関数を記述している部分」または「関数プロ
トタイプ宣言」を解析対象にしますので、インクルードパスやプロ
ジェクトの情報などの面倒な設定は必要なく、すぐに、簡単に使え
ます。
② ソース中の規定のフォーマットで書かれているコメントから情報を
抽出して、関数ヘッダに更新履歴の一覧を作成します。
③ Microsoft(R) Visual Studio シリーズのアドインにより、Visual C++
のソースコードエディタで編集中のソースコードから関数ヘッダを
簡単に作成できます。
とかく時間に余裕のないプログラム開発の現場では、コーディングと
デバッグが重視され、メンテナンスのためのコメント挿入や仕様書の作
成はおろそかにされる傾向があります。しかしながら、企業間のソフト
ウェア受発注においては、納品の際にソースコードのメンテナンス性も
チェックされますし、仕様書にも一定の品質が要求されます。また、コ
メント・仕様書の類が障害発生時の調査において役立つことは言うまで
もありません。
そんなコメント・仕様書の作成作業を効率化する関数ヘッダメーカー
は、個人開発から統合プロジェクトの開発作業まで幅広く、プログラミ
ングを側面から、強力に、支援いたします。
┃§３ 関数ヘッダメーカーの特徴
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
ここでは関数ヘッダメーカーの特徴である下記項目について説明します。
① ソースコードから関数ヘッダの雛形を自動生成
② 充実したテキスト処理（コメント入力はベタ書きでOK）
③ 以前入力したコメントを自動的に補填
④ ソースコードに埋め込まれている関数ヘッダを再編集可能
⑤ ソースコードの更新内容をヘッダに反映するのも簡単
⑥ 所定のフォーマットのコメントから更新履歴一覧を作成可能
⑦ 出力フォーマットを定義可能
⑧ HTML 形式の関数ドキュメントを出力可能
⑨ 面倒な設定は不要
⑩ Microsoft(R) Visual C++ シリーズのアドインを提供
①ソースコードから関数ヘッダの雛形を自動生成
C/C++ のソースコードを解析して「関数型・関数名・アクセス制御型」
「パラメータ」「戻り値」「大域変数」「static変数」「更新履歴」
に関する情報を収集、自動的に関数ヘッダの雛形を作成します。
関数名や関数型など、機械的に解析できる情報の他に、例えば、
return ステートメントの後ろにコメントがあれば、それを戻り値のコ
メントとして抽出し、関数ヘッダに取り込むということもできます。
関数ヘッダの雛形は、「.c .cpp ファイル中に記述されている関数本体」
または「関数プロトタイプ宣言」のいずれかから作成することができます。
②充実したテキスト処理（コメント入力はベタ書きでOK）
ヘッダの編集作業において、ユーザは所定のテキストボックスにコメ
ントをベタ書きで入力すればよく、後は関数ヘッダメーカーが「行頭の
コメント記号」「インデントのための空白」「折り返しのための改行」
を適切に挿入し、文書のフォーマットを整えます。
また、箇条書きや罫線画などの書式も処理し、プレーンテキストであ
りながら表現力豊かなドキュメントを出力できます。
③以前入力したコメントを自動的に補填
例えば、関数ヘッダの編集作業において ERROR_SUCCESS という戻り
値に「正常終了」というコメントをつけたとします。関数ヘッダメーカー
はこのコメントを記憶し、次回 ERROR_SUCCESS を戻り値として検出し
た場合には、自動的に「正常終了」というコメントを補填します。これ
により、コメント入力に関するユーザの負担は軽減されます。
コメントの自動補填は「パラメータ」「戻り値」「大域変数」
「static変数」に対して機能します。
④ソースコードに埋め込まれている関数ヘッダを再編集可能
以前作成し、現在はソースコード中に埋め込まれている関数ヘッダを、
再度読み込んで編集することができます。
⑤ソースコードの更新内容をヘッダに反映するのも簡単
プログラム開発においては、ソースコードに修正が入るのは日常茶飯
事です。ですが、忙しさのあまり、コメントの修正まで手が回らず、関
数ヘッダの内容と実際のソースが食い違うという状況もよく目にします。
関数ヘッダメーカーを使うと、ソースコードの更新内容を既存の関数
ヘッダに自動的に反映することができますので、このようなヘッダと実
際の関数の食い違いを防止できます。
⑥所定のフォーマットのコメントから更新履歴一覧を作成可能
所定のフォーマットで記述されたシングルラインコメントを更新履歴
として抽出し、関数ヘッダに更新履歴の一覧を自動作成することができ
ます。
⑦出力フォームを定義可能
出力フォームをユーザが定義することができます。この機能を使って
独自の関数ヘッダを作成できます。
※注意 ユーザが定義した形式で出力したヘッダに関しては
上記④で説明されている「再読み込みして編集」の
機能は使えませんのでご注意ください。
⑧HTML 形式の関数ドキュメントを出力可能
上記⑦の「出力フォーム定義」の機能を使うと HTML 形式のドキュメ
ントを出力することができます。HTML形式でドキュメントを出力するこ
とで、より見栄えのよいドキュメントを作成できます。また、共通関数
の関数仕様書をプロジェクトのホームページで公開するといった作業も
楽になります。編集中の関数ヘッダはブラウザを使ってプレビューする
ことができます。
⑨面倒な設定は不要
「.c .cpp ファイル中で関数の実体を記述している部分」または「関
数プロトタイプ宣言」を解析対象として関数ヘッダの雛形を作成します
ので、「インクルードファイルの検索パス」や「開発環境のプロジェク
トに関する情報」等に関する複雑な設定は必要ありません。次の３ステッ
プで関数ヘッダの雛形を作成できます。
1) エディタで編集中のソースコードで、ヘッダを作成する関数を選択
2) 選択をクリップボードへコピー
3) 関数ヘッダメーカーを起動し、クリップボードのソースコードを解析
⑩Microsoft(R) Visual C++ シリーズのアドインを提供
Microsoft(R) Visual C++ 6.0/.NET 2003, Microsoft(R) eMbedded
Visual C++ 3.0/4.0 のアドインを提供していますので、Visual Studio
のソースコードエディターで編集中のソースコードから簡単に関数ヘッ
ダを作成できます。また、作成したヘッダをソースコードに埋め込むの
も、ソースコード中のヘッダを再編集するのも簡単に行えます。
┃§４ 動作環境
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
OS:
Windows 98SE/Me/2000/XP
CPU:
Pentium Ⅲ 500MHz 以上を推奨
必要ディスク容量：
インストールするドライブに3MB
開発環境：
Microsoft(R) Visual C++ 6.0/.NET 2003
Microsoft(R) eMbedded Visual Tool 3.0/4.0
その他 C/C++ のソースコードを編集できる開発環境またはエディタ
アカウント：
制限ユーザであっても使用できますが、インストールはコンピュー
タ管理者のIDで行ってください。
また、制限ユーザでは Microsoft Visual C++ シリーズのアドインが
使用できませんので、ご注意ください。
┃§５ ダウンロード先
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
関数ヘッダメーカー V1.0 は作者ホームページよりダウンロードできます。
http://www.fermes-soft.com
2004年 7月末日まで、V1.0ダウンロード開始記念キャンペーンを実施い
たします。通常価格 1,980円がキャンペーン価格 1,280円でご購入いただ
けます。
通常価格 ： 1,980 円
キャンペーン価格： 1,280 円
┃§６ 問い合わせ先
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
関数ヘッダメーカーV1.0 の技術的なお問い合わせは作者ホームペー
ジの掲示板にてお受けしています。
配布物の転載や雑誌等への記事掲載に関するお問い合わせは
info@fermes-soft.com にメールにてお問い合わせください。
その他の事項につきましては support@fermes-soft.com へメールに
てお問い合わせください。
以上
|
