リストHOME  リストOpen Source

Vbadoc

お知らせ

2024/03/02

 出力文字列の最後の文字が、行末(A4の右端)だった場合に、改行が1つ余分に挿入される不具合を修正しました。改行を入れる処理の前に、最後の文字かどうかをチェックする条件を追加することにより修正しましたので、ご確認ください。




2024/02/23

 サンプルのブックをオープン中に、他のブックを編集していると、オープン時の処理で異常が発生します。原因は、非アクティブな状態で、ブックのシートを選択(Selectメソッド)していることによるものです。修正しましたので、ご確認ください。他にも少し変更点があります。



概要

 今回は、VBAプログラムの簡易構文解析(パーサー)を利用したドキュメント出力ツール(vbadoc)を公開したいと思います。


 ドキュメントの出力は、VBAプログラムのコメントを解析し、簡易なソフトウェア設計書を出力する仕様となっています。コメントはある規則に従って記述する必要がありますが、その規約については、こちらの『コメント規約』をお読みください。


 また、パース処理の結果を中間ファイルとして、テキスト形式で保存してありますので、一度、パース処理を行えば、こちらの中間ファイルをメモ帳などのテキストエディタで直接編集することにより、出力するドキュメントの内容を変更することができます。


 出力する文章の雛形は、データーベース化してありますので、そちらを変更することで、文章の常体(である調)/敬体(です、ます調)を変更することも出来ます。


 フォントは、MSゴシックとMS明朝の2つの等幅フォントのみの仕様となっていますが、これは、等幅フォントを採用することで、ページの右端部の改行の位置を計算し易くするために、そのようにしてあります。等幅フォントを採用すれば、全角1文字の幅が、必ず半角2文字分の幅になるため、文章の折り返し位置が、容易に計算できるメリットがあります。


 今回、私が作成したvbadocの出力ドキュメントのデザインは、シンプルさを優先して作成していますが、みなさんの方で、ご自由にソースコードをカスタマイズして、出力ドキュメントの形式や見映えを、自分好みに変更して、ご利用頂けたらと思います。


 ドキュメントの出力手順は以下の2段階となっています。



 ちなみに、出力ドキュメントをPDF化したサンプルは、こんな感じです。ソースコードに、決まった規則でコメントを記入しておけば、このような簡易なソフトウェア設計書を出力することが出来るようになります。


 ソースコードは、Microsoft社の製品 エクセル向けに書いたものなので、利用するには、ご使用のコンピュータに、エクセルがインストールされていることが、必須条件です。


 以下は、サンプル画面です。

vbadocのサンプル


技術ポイント


所感

 ドキュメントをエクセルで出力するように決めて、開発作業を行なっていたのですが、行の折り返しを計算しなくては、いけないことに途中で気付き、ちょっと失敗したかなと思ったのですが、等幅フォントを使用することで、なんとか完成まで持っていくことが出来ました。


 私は、ワードでのVBA開発経験がないのですが、出力ドキュメントにワードを採用するのも、ありなのかも知れません(できなかったら、すみません)。文書を作成するなら、文書編集アプリのワードを採用する方が、自然ですよね。



改善案

 先にも述べましたが、私は、見た目のシンプルさを優先して、ドキュメントのデザインを設計しました。私の好みと皆さんの好みは違うと思いますので、改善案としては、見た目を自分好みに改善していくのが良いのではないでしょうか。



ダウンロード



サンプルデータについて

 サンプルに含まれるデータは、私の創作によるものです、サンプルデータに含まれる個人名、会社名などの情報は、実在の人物とはまったく関係ありません。



免責事項

 作者は、本ソフトウェアの使用または使用不能から生じるコンピュータの故障、情報の消失、その他あらゆる直接的及び間接的被害に関して一切の責任を負いません。



不具合の報告

 ご使用にあたり、改善の要望、不具合の発生等ありましたら、画面下のアドレスまで、ご連絡頂きますよう、宜しくお願いいたします。ご面倒、ご不便をお掛けしますが、宜しくお願いいたします。




休日判定・ページのフッター
管理者のメールアドレス