ソースの声を拾う

ソースは開発の結果だ。結果から上流工程に差し戻せば、それは正確性が優れたドキュメントになる。

ソースの声を拾う

プログラムソースは全てを物語っている。機能も、画面も、バグも全てその中にある。システムのソース全体を理解すれば、システム自体が理解できてくる。ソースを効率よく読む能力はプログラマーにとって重要だ。

とは言いつつも概略の説明くらいは欲しい。特にクラスの内容や、関数の説明だ。そんなわざわざ仕様書に書き起こす必要は無い、ソースと切り離せば、内容の矛盾が起きるだけだ。

本日紹介するオープンソース・ソフトウェアはDelphiDoc、Delphiのソースからドキュメントを生成するソフトウェアだ。

○○Doc、と言うアプリケーションは数多い。JavaDoc、phpDocumentor、JSDoc、更にRubyDocなど。上流から構築する仕様書と、下流から仕上げる仕様書、二つが揃えば怖いものは無い。

Delphiを使った事がないので、試してはいないが、この種のソフトウェアには珍しくGUIインタフェース付だ。Dephiを使ったプロジェクトでは導入を検討するべきだ。

ソースの声なき声を拾い上げ、見られる形にしてくれるDelphiDoc、利用頻度の割に作成に時間のかかるドキュメント作成の時間を一気に短縮してくれるだろう。

DelphiDoc レビューはこちら