神々が見ている〜ソースのコメントは保守担当者だって見る〜

ギリシャの彫刻家フェイディアスの話だった。
紀元前４４０年ごろ、彼はアテネのパンテオンの屋根に立つ彫像郡を完成させた。
それらは、今日でも静養最高の彫刻とされている。
だが、彫像の完成後、フェイディアスの請求書に対し、アテネの会計官は支払いを拒んだ。
「彫像の背中は見えない。誰にも見えない部分まで掘って、請求してくるとは何ごとか」と言った。それに対して、フェイディアスは次のように答えた。
「そんなことはない。神々が見ている」

〜P.F.ドラッカー：「プロフェッショナルの条件」より抜粋〜

私たちが作るソフトウェアは、ユーザからしてみれば、ユーザの要求どおりに動けばよいのかも知れません。ソースコードのコメントは、いくら書いてあってもユーザの目に触れることは無くシステムは動いてしまいます。

しかし、保守をする場合は違ってきます。

ユーザーからすれば見えていなくても保守をする側からすれば必要な情報です。
確かに、作成者と保守担当者が同じならば大丈夫なのかもしれません。
しかし、作成者と保守担当者が違うことなどよくある話です。

ソースコードにコメントが無いと、保守担当者は迅速な対応ができません。
それどころか、満足いく対応すら出来なくなってしまう可能性もありまし、いくら設計書があったとしても、設計書とソースコードのトレーサビリティ(追従性)が著しくさがるかと思います。

ソースコードのコメントを見るのは神々だけではありません。
作成者とは別の保守担当者も見るのです。
ソースコードのコメントをしっかり書くことは、時間やお金を掛けてでも非常に重要なのではないでしょうか。

ソースコードのコメントはユーザからしてみれば、必要ないように思えます。
しかし、コメントが無い事が原因で保守がうまく行かない場合もあるということを知っておく必要があるとおもいます。
そして、SEは、それをうまくユーザにも説明しなければならないのではないでしょうか。

フェイディアスはプロとして最高の仕事をしていた(しようとしていた)のではないでしょうか。
私たちソフトウェアエンジニアも最高のソフトウェアをめざして、また、全体的(最終的)なコストダウンを目指して、やるべきことをやる必要があるのだと思います。

※今回は、ソースコードのコメントに焦点をあてていますが、設計なども同じです。神々だけでなく保守担当者も見ます。