リーダブルコードを英文で読むあなたへ。 その4

おはようございます。

今日は

CHAPTER FIVE 　〜 Knowing What to Comment〜

わかりやすいコメントの内容についてです。

コメントは変数でまかないきれていない情報を補足で補うためのものだけど、コメントに書かれている事実だけを記述していることが多い。またコメントによって情報を付け足すのも大事だけどその前にもう一度書かれているコードを見つめ直す必要がある。コードにコメントを補足するよりも、いい説明がされているコードを見る方が明らかにわかりやすい筈だから。

・難しい単語

mundane

leave out

declaration

virtually

innocent-looking comment

registry

crutch

Director Commentary

insight

optimizer

admittedly

impose 

jotting down

intimately：親密に、心から

anticipating：考える

relinquish

allocator

prevent

plementation

caveat

involve：巻き込む  be involved with：関与している、（プロジェクトに）参加している

nitty-gritty：問題の確信、基本的事実

permission：許可、承認

overwhelmed：圧倒される、感服する

neatly：きちんと

bulleted summary：箇条書きで要約されていること

gist：要旨

catchy：キャッチー、人の心を捉えた

implemment：実装する

duplicate：重複

crutch：松葉杖

flaws：傷

anticipate：予測する

・感想

どんなコメントを残すか考えるより、まずファーストステップとしてとにかくコメントを書くことが大事だと気づきました。そしてあとからwhat not to commentを見つけ出したり、コメントする以前にコードを変えられないかを考えたりする”見直し”をすることが重要だと感じます。コメント次第でコードの読みやすさが変わるこをを実感しています。