おーみんだよ。

おーみんだよ。

プログラミング、Unityなどのアウトプットを主に行っています。

【プログラミング】コメントは必要最小限にすること。

f:id:bookreadkun:20190513162947p:plain

 

おはようございます。おーみん(@Ooooooomin_365)です。

 

現在、『実戦で役立つC#プログラミングのイディオム/定石&パターン』にてC#の学習中です。

『実践で役立つC#プログラミングのイディオム/定石&パターン』を読んでみる! - おーみんだよ。

 

今回はプログラミングの可読性に影響する「コメント」についてまとめていこうと思います。

 

コメントについて

いきなりですが、皆さんはコメントって書いていますか?

 

プログラム中に(C#なら)「/*~*/」または「//~」と書いてメソッドの説明をしたりするアレです。

 

僕は結構書いていたんですよ。きっと分かりやすいだろうな~と思って。

 

しかしですね...。

『実戦で役立つC#プログラミングのイディオム/定石&パターン』を読んでいると、まさかのコメントを詳しく書くのはダメ!!!と書かれていたのです。

 

コメントは必要最小限にすること

 

コメントに関して上記で紹介した本の著者はこう述べていました。

 

 コメントが多すぎるコードは、裏を返せばわかりにくいコードであるということです。コメントとコードが一致しているという保証はありませんから、コメントが多すぎるコードはかえって可読性を落としてしまいます。

 

ふむふむ。まあ確かに。

 

コメントを書くにもコストがかかっています。

コードを変更したらコメントも見直す必要がありますから、コメントが多すぎれば、その分のコストも増えることになります。

限られた時間の中で、どこに時間をかけるかという優先順位を考えた場合、コメントを書くよりも、わかりやすいコードを書くことに時間をかけるほうが賢明です。 

 

お、、、おう。確かに。

 

確かに現在は一人でプログラムを書いて満足してしまっているので良いかもしれませんが、本来プログラミングは複数人で行うものです。

 

コードを書いた後に確認のためにレビューを行いますし、保守の方がコードを修正することもあるわけです。

 

その時にコメントがたくさん書かれていると、見栄えも微妙だし、コードを修正した際にコメントも一緒に直す必要が出てきてしまいます。

 

良かれと思っていたことが、後々に混乱を呼んでしまうのですな...。

コメントはコードから読み取れない内容や、強調したい内容のみを書くのがベストとのことなので、今後からは気を付けたいと思います。