オルタナティブ・ブログ > 隠れた財産 >

Make Applications More Valuable

プログラムのコメントに関する考察

»

ソースコードのコメントよりも空白行のほうが理解を助けるという研究結果

ソースコードの読みやすさというのは、やはり重要と思います。

適切なコメントは、確かに有用なケースがありますが、コードは経年変化していきますので、それに合わせて、コメントも最新状態にするのも結構大変です。

これは、複数人で開発するソフトウェアの場合、さらに顕著で、一人でもそのルールを守らなければ、規律はすぐに失われていくし、年月が立ち、保守担当者が変わったりすると、当初の目的の伝承が途切れる可能性もあります。

ですので、コメントは、コードだけでは何をやっているのかが理解しにくいものに限定したほうがよいのではないかと思っています。

特に読みにくさを増す要素として、仕様変更が発生した時に以前のコードをコメントとして残すという方針を採っているコードを良く見かけますが、これは本当にコードの見通しを悪くします。

これは、ソースで管理するのではなく、ソース管理システム(世代管理)などのツールに任せるべきものと思います。

Comment(2)

コメント

石松

石松と申します。
devをやってます。
コメントはあってもいい、時にはある方が良いけど出来れば英語でやってもらいたいです。
10年ほど前、ドイツのソフトのライセンスを買って自社のソフトに対応しようとしてコードを見たらコメントがドイツ語。
分かりやすいコードで良かったけど重要な所のコメントがドイツ語ということがガンでした。
全く佐藤さんや森崎さんのブログの主題とはずいぶんかけ離れたコメントですみません。

ウルフ

石松さん

コメントありがとうございます。

コメントを日本語で書くのは、日本人にはいいかもしれませんが、
ひょっとしたらそのソフトが将来海外で使われるかもしれませんので、
下手でもいいから英語で書くほうが親切かもしれませんね。 

でも、微妙なニュアンスを母国語でないもので表現するのは難しいかもしれません。

コメントを投稿する