2018-02-10

身につけるべきプログラマの習慣 その3

明日の自分は他人と思う

プログラマであれば、特にコメントに気を遣いましょう。コメントは後で書くのではなく、コードと同時に書かなければいけません。明日どころか、10分後にはなぜそのようなコードを書いたのか判らなくなることさえあるからです。

しかし、プログラミングでコメントに依存したコードを書くのは完全にNGです。コメントの内容は必ずしも信用できないからです。特に、修正を繰り返したコードは、コメントがメンテナンスされていないことが多々あります。
なので、第一義的にはコメントを読まなくても理解しやすいコードを目指します。
そして、コメントはコード自体では何をしているか判りにくい箇所を捕捉し、コードの可読性を高めることを目的とします。

このようにすることで、多大な複雑系で疲弊し、記憶することを放棄した脳にも優しくなり、明日他人になった自分を取り戻すことができるようになります。

そして、それは本当の他人に対しても優しくなり、保守性、つまりソフトウエア制作における「質」の要素の1つ、を改善することができるのです。


自分を含めた他人に対して優しく作ること、それは善意のあるソフトウエア制作であり、技術者の善意、という最近では忘れられてしまった大切な精神を思い出させる行為でもありますね。

これなくして、技術者は成立しない「何か」の1つなのではないでしょうか。


0 件のコメント:

コメントを投稿