|
|
ＶＢＡモジュール仕様書作成手順 |
概要
|
関数仕様を作成するのもなかなか面倒なので、ツールを使って簡単に
プロシージャ記述書(HTML)を作成する手順をご紹介します
|
VBA関数仕様書作成ツール
|
@Vectorなどからツールをダウンロード
 Excel VBAプロシジャー仕様書作成支援ツール(EVbaDAss)⇒ ダウンロード |
A今回使用するバッチ、秀丸マクロをダウンロード
|
ModHtmlMake.lzh ├ HTML作成用バッチ/ │ ├ html.bat │ └ html2.bat ├ 秀丸用マクロ/ │ ├ HTML整形＆保存.mac │ └ モジュール一覧修正.mac └ HTML用リソース/ ├ image/ └ main.css ⇒ ダウンロード |
B作業ディレクトリに以下のバッチを配置(ModHtmlMake.lzhに含まれます)
|
html.bat html2.bat(※秀丸本体のパスを修正) |
C秀丸の実行ディレクトリに以下のマクロを配置(ModHtmlMake.lzhに含まれます)
|
HTML整形＆保存.mac モジュール一覧修正.mac |
|
マクロの関数ヘッダを整形
|
@VBEでマクロの関数ヘッダを整形
|
'先頭行にモジュールの概要を記述(一覧に表示) '２行目から ' ： '有意行までのコメントをモジュールの概要として扱う '-------------------------------------------------------- '【機能】：関数の宣言の直前の行のコメント(一行のみ)を、関数の概要として扱う Function Function名( ParaA As Integer, ParaB As String ) As Boolean '宣言の直後から、有意行(又は空行)までを関数の解説として扱う ' 'ParaA:引数ParaAの説明 'ParaB:引数ParaBの説明 'Function名:戻り値の説明 '-------------------------------------------------------- End Function |
↓手順に沿って実行すると以下のように出力されます
|
先頭行にモジュールの概要を記述(一覧に表示) ２行目から ： 有意行までのコメントをモジュールの概要として扱う |
| 関数名 | Function名 | ||||||
| 概要 | 【機能】：関数の宣言の直前の行のコメント(一行のみ)を、関数の概要として扱う | ||||||
| 処理 |
宣言の直後から、有意行(又は空行)までを関数の解説として扱う |
||||||
| 形式 | Function Function名( ParaA As Integer, ParaB As String ) As Boolean | ||||||
| 可視性 | パブリック | ||||||
| 引数 |
|
||||||
| 戻り値 |
|
|
マクロから全モジュールをエクスポート
|
@作業ディレクトリにVBAモジュールをエクスポート
一括エクスポートツールなど利用すると便利
|
エクセルVBAモジュールの一括エクスポート(EVC) ⇒ ダウンロード |
|
EVbaDAss.exe実行
|
@作業ディレクトリを指定して実行
|
入出力フォルダ：作業ディレクトリ(モジュール格納先)を指定 モジュール一覧：「モジュール一覧」と入力  [出力項目名:プロシジャー仕様書]を設定(秀丸のHTML整形で使用) ----------------------------------------- [プロシジャー記述書] ---------------------------------------- [関数名][関数名] [概要] [処理] [形式] [可視性] [引数] [戻り値] ----------------------------------------  [出力項目名:モジュール一覧]を設定(秀丸のHTML整形で使用) ----------------------------------------- [モジュール一覧] --------------------+-------------------- [モジュール名][概要]|[有効Step]/[全Step] --------------------+--------------------  |
|
バッチhtml.batでHTML作成
|
@秀丸のマクロを配置
|
■秀丸のマクロを秀丸の実行ディレクトリに配置 ⇒HTML整形＆保存.mac ⇒モジュール一覧修正.mac （※HTMLの共通ヘッダはここで書き込まれますので必要に応じて編集します） |
Aテキストエディタでhtml.batを修正(モジュール名,出力先HTML名)
|
■html.batの内容----------------------------------------- call html2.bat モジュール名 出力先HTML名 ： --------------------------------------------------------- |
Bテキストエディタでhtml2.batを修正(秀丸のパス部分)
|
■html2.batの内容---------------------------------------- rem ↓秀丸の実行パスを環境に合わせて修正してください rem ------------------------------------------------ set HIDEMARU=C:\tools\エディタ\秀丸\hidemaru.exe rem ------------------------------------------------ del %2.htm copy %1.htm %2.htm %HIDEMARU% /xHTML整形＆保存.mac %2.htm %HIDEMARU% /xモジュール一覧修正.mac %2.htm set HIDEMARU= --------------------------------------------------------- |
Cコンソールからhtml.batを実行
D作業ディレクトリにHTMLファイルが出力されます
E作業ディレクトリに以下のリソースを配置(ModHtmlMake.lzhに含まれます)
|
image/*.gif main.css |