Subscribed unsubscribe Subscribe Subscribe

コードをドキュメントに

考えさせられごと

名言。

未来のいつか/hyoshiokの日記 - いろいろ

無駄なドキュメントを書く時間があるならコードをドキュメントにしろ。

- - -

ソースにコメントをたくさん書け、ということでも、

「ソースにコメント形式で書くとドキュメントに抽出される」エンジン系を使え、っていうことでもなくて(これは別に否定されないでしょうが)、

わかる程度にきちんとコメントを書きつつ、見通しのいいロジックで、

って感じですかね。

私的には、ソースコードって、初回版より次回改造版の方がよいソースコードになります。

やりたいことが整理できて、洗練されて短くなって、やったことを忘れてるので思い出しながらコメントを書き、って感じで。

それでほんとうによいコードになっているかはわかりませんが、少なくともそう信じていますので、前に書いた自分のコードをふたたび見るのは大好きです。

改造が必要ない部分/ファイルでも、コメントだけ書き足してソース管理に入れなおすこともあります。

そうやって改定を重ねて、時を経たソースコードは、やっと、「人に見せてもいいかな」って感じがします。

まぁ、そうじゃないコードも他人に面倒をみてもらわざるを得ない状況は多々ありますので、そんなものを押し付けられてしまった不幸な関係者各位に心の中で平謝りしつつ・・・。

1回目から整ったソースコードを書く方法はないだろうか、と考えたら、それは結局、実装する前にキレイな仕様書を書くのと同じなような気もするわけで。事実上ムリでしょうし。だって作る前から完全な設計図というのは、やることが完全にわかっている定型作業であれば可能でしょうけれど。

ソースコードは容易にコピー&ペーストできますので、「新しいことが一切ない」という場合には、書く必要もなかったりしますので、結局、何か作るときには新しい事柄は入ってしまうもの

で、今たどり着いた何となしの結論は、プロトタイピングです(当たり前・・・)。1回目のリリースを、自分の中では2+回目のリリースにする、と。

いや、そうは問屋がなかなか卸さないような気もしますが。まあ、そういう気持ちで。

- - -

あと、仕様書は、なるべくソースにコピーして、それから実装に入ります。

料理の鉄人」で、和の鉄人・道場六三郎が最初にお品書きを書くような気持ちです。

もちろん自分で書く場合はをソースにコピーすることを念頭に置いて書きますので効率がいいです。。。

#うわ、自分Loveかよ。

 所詮、受注でない開発者のエゴなのでしょうね。