2008年1月15日

ドキュメント書きを楽に出来ないかと思う愚痴

ドキュメント書いてます。
WindowsアプリのGUI部分。
呼び方は方々でまちまちですが、コントロールのレイアウト書いたり、それとクラスを結びつけるコードレベルの話を書くやつ。詳細設計書?
コントロールのレイアウトを書いて、関連付ける変数を決めるのにClassWizard(もしくはそれ相当)を使っているので、個人フェーズがプロトタイピング的な進め方になります。
そうすると仕事の流れは次のようになります。
ソース試作→ドキュメント作成→(紆余曲折)→改修→ドキュメント改修(ここがウザい)→(続く)
ドキュメントは、高い確率でWordを使います。
Wordは、手練(てだれ)が使えばそりゃあもう素敵なビジネス文書が出来るんでしょう。
書き直しがめっちゃ面倒だけど。
自分もそれなりにWordで揉まれてきた方ですが、Wordのファイルを書き直すのはとにかく大変。
エディタでテキストを直すのだって大変なのに図表まで直す必要があるときはいつ眠くなってもおかしくない。
Wordは、普段キーボードでタイピングしているところに、メニューを開いて操作しないといけない仕事が割り込みます。
呼び出すべき項目やキーボードショートカットを覚えていれば、マウスに持ち替える手数が減ると思うのですが、その域に達するのは大変です。
方々でみかける発言で、同意できる意見に「ソースが仕様書である。ここにはウソは無いし真実である」というものがあります。
この発言を盾に「ドキュメントなんてみんな書けないもの」と開き直っている人もたまにいますが、それではいけないという意見にもうなづけます。
とはいえ、書かなくていいなら書きたくないのがドキュメント。
ソースコードを放り込んだら各種コメントを抽出して引数と返り値を読み取ってくれるツールって無いですか?
変更がかかったときは、そいつに放り込んで常に最新のドキュメントの雛形ができるの。
みんなきっと思っているはずだ!!
んでもって、ツールはあるんだけどとても手が出ないような値段だったりするんだ。
検索して大概見つかるのはDoxygenとSandCastleだけという現実を否定したいんです。熱くなってしまいましたごめんなさいorz
とはいえ、無いなら作ろうと思った人だってきっといるはず。自分も妄想ぐらいした。
ソースのパースがどのぐらい面倒かを考えるあたりで断念してしまうんだけど。
ソースがパース出来たとして、それをWordのVBAにでも渡せばそこから雛形は作れると思う。
パースを外部で行ってXMLか何かに保存。
で、C#と.NET FrameworkあたりでXMLを読み込んでファイル出力できませんか?
つかSandCastleがサポートから外すほどなんですか。C/C++というのは!?
と、鼻息がまた荒くなったところでyaccを見つけましたorz
これ使えば出来るんじゃあ・・・と妄言を吐くだけにしておきます。誰か作ってください。
# 最悪の締めですよ? 当然覚悟しております

0 件のコメント: