Overview VBDOX is a simple program that generates technical documentation from source comments. The only requirement is to use specific module and function comments format. Documentation is generated for all types Visual Basic files and also for VBScript and ASP (limited support) The program can be extended to support different documentation comments and reports. Right now the program has three re
VBソースをvbfilterを通してDoxygenに掛けても、プロシージャ内部のコードは全部捨てられるので、自動的に関数呼び出しグラフを作ってくれたりということはできません。が、自力で必要な情報をコメントに書き記していく分にはそれなりに使えるかと思います。 どんな変数やプロシージャがあるかが見通しよくなりますし、関数呼び出しグラフのdotを自分で書くのもそう難しくはありません。自動生成と違って、プログラムを変更したら合わせて自分で書き換える必要はありますが。 呼び出しグラフのdot記述例 例えば、フォームfrmFのプロシージャprocXから標準モジュールmdlMの関数fncYをコールしていることを表すdotは次のように書きます。コメントの書式はpython版vbfilterのものです。 '* 関数の呼び出しグラフ: '* @dot '* digraph caller { '*
普段の仕事はアーキテクトやDBAやらフロントSEが多いんですが 久々に、1プログラマとして、自分の関わっていないフレームワークで 自分の関わっていない仕様書に則ってプログラミングをしました。 やってみると、結構気づかなかったことに気づきます。 プログラミングしていて困ったのは、 「この記述はどこを探せばいいのか?」 「他のメンバーと統一できているのか?」 といった「迷い」であり、これらの時間が最も効率を下げると思います。 そういうことで、フレームワークでコーディングの効率を上げるよりも、 以下の資料をしっかりとまとめておく方が、開発効率の向上に効果があるとおもう。 変数や画面項目名の名前付けのルールが整っていること 全体資料が整っていること メッセージ登録の一覧 ER図 コピペで実装したくなる気持ちも分った。 コーディングルールがあいまいだったり、 フレームワークが提供する部品の使い方がよ
かなり前のひがさんのブログを引用 仕様が固まった後に作成するドキュメントは、プログラムと一対一になるようなドキュメントではない。そんなのはプログラムを見ればすむ話だから。メンテナンスする人が必要になるドキュメントを書く。メンテナンスする人にとってはドキュメントは必要ですよ。全部ソース読めはきつい。 http://d.hatena.ne.jp/higayasuo/20080721/1216607451 さて、メンテナンスに必要な設計書ってどんなだろうか。 出来上がったシステムを見ながら考えてみる。 機能概要は必須 機能の概要がわかるものが欲しいけど、 ”機能”の一覧よりは、”要件”の一覧が良い。 例えば、「商品マスタデータのメンテナンス機能」だとしたら、 登録ボタンを押したら、画面の入力に従って商品データが登録される その際に、商品テーブルと価格テーブルと価格履歴テーブルにデータが登録される
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く