In 勉強

【リーダブルコード】6章のまとめ

「コメントは正確に簡潔に」を

まとめていきます。

5章はこちら

コメントを書くコツ

本章の内容は、ざっくりコメントを書く際のコツを紹介してます。

どのような事を書けば伝わりやすいのか。

短く簡潔に詳細にコメントを書くことが求められます。

 

まとめ

①「それ」「これ」などの代名詞を使わない。

代名詞を使うことは、文章として問題ない。

しかし、理解のしやすさという点においては、

代名詞を使わずに、何が「それ」「これ」の部分に、

入るのかを明確にする方が理解しやすい。

 

②処理の概要をコメントする。

見たらわかるやん!というコメントはしない。

どういった目的で、何をするための処理なのかをコメントする。

これは、その処理が間違ってるかの検査にもなる為、

大変重要だと思う。

 

③コメントは簡潔に。

よくない例

’メールが閲覧されているかどうかを判断し、表示、非表示を制御する。

よい例

’メールが閲覧されている場合、非表示にする。

上手い例えかは微妙だが、

何を行う処理であるかを明確にする事が大事である。

 

④言語やツール内のコメント機能を活用する。

メソッドの引数に対して、インラインコメントをつける。

コメントを書く際に、param,historyなどクラスやメソッドに対して、

カーソルを合わせた際に、コメントが表示される機能を活用する。

 

所感

本章は、国語力的な内容でした。

頭の良い人や気遣い、コミュニケーション能力が高い人は、(話が上手い人など

自然と出来そうな内容ですね。

改めて、業務内での自分のコメントを振り返って、

良いコメントをかけているか確認したいなと思いました!

 

6章のまとめ「コメントは正確で簡潔に」。

 

,