第2話 Doxygen

 出先の会社の社長とクソTが大声でDoxygenについて話し合っている。

 どちらもこれは凄いプログラムだと誉めあっている。

 それを聞きながら、どちらもプログラムの素人だなと断じた。社長が無知なのは仕方ないとして、プロジェクトリーダーのクソTまでが Doxygen を誉めるのはいただけない。


 ソフトプロジェクトをお客様に納めるのに必須なものが二つある。

 一つはソースコードそのもの。もう一つは設計書である。

 このときソースコードから自動で設計書を作るのがこのDoxygenというソフトウェアである。

 だがそれは『設計書に見えるもの』でしかない。要は何も知らないお客様を満足させるためだけの体裁を整えただけのクズ文書である。

 その正体は各関数の呼び出し関係とそこに散りばめられたコメントを適当に集めたものである。

 これを読んでもプログラムの構成も働きも設計経緯も少しも分からない。実際の保守の役には欠片も役に立たない代物である。

 そして何のメリットもない割にデメリットは山ほどある。

 コメント記述などに演算式に使う記号を流用しているため、ソースコードは各段に読み難くなる。注意してコメントを入れないと設計書の体裁さえ作れなくなる。

 こうなるとデバッグそのものにより多くの手間がかかるようになる。

 つまりは本末転倒なのだ。こんな苦労をするぐらいならば素直に設計書を書いた方がよい。


 こんなものを二人して凄い凄いと喜んでいるのだから見ていて憂鬱になる。


 そしてこの予感は後に現実のものになる。

  • Xで共有
  • Facebookで共有
  • はてなブックマークでブックマーク

作者を応援しよう!

ハートをクリックで、簡単に応援の気持ちを伝えられます。(ログインが必要です)

応援したユーザー

応援すると応援コメントも書けます

新規登録で充実の読書を

マイページ
読書の状況から作品を自動で分類して簡単に管理できる
小説の未読話数がひと目でわかり前回の続きから読める
フォローしたユーザーの活動を追える
通知
小説の更新や作者の新作の情報を受け取れる
閲覧履歴
以前読んだ小説が一覧で見つけやすい
新規ユーザー登録無料

アカウントをお持ちの方はログイン

カクヨムで可能な読書体験をくわしく知る