2022-10-01から1ヶ月間の記事一覧
コメントすべきでないこと、すべきなこと コメントの目的とはなんでしょうか? それは書き手の意図を読み手に知らせることです。 ただし、全ての意図をコメントすればいいわけではありません。 コメントを読むということはその分だけコードを読む時間が減る…
優れたソースコードは「目に優しい」 見た目が美しいコードの方が読みやすいはずですよね。 改行やインデントがメチャクチャなコードは大変読みにくいです。 この章では見た目的にコードを読みやすくするための三つの要素と原則が紹介されています。 要素 余…
最善の名前とは誤解されない名前をつける! ある変数や関数名をつけた際には「他の意味に取られることはないか?」を自問するべきです。 以下では自問・検討の仕方を見ていきます。 曖昧な名前を避ける 変数に対して代入されるものが、何かに処理をくわえて…
初めに 変数名や関数名には情報を詰め込むべきです。 例えば、 data や tmp などは情報があまり含まれていないといえます(経験としてdataを使った際にレビューをいただいたことが)。 情報を詰め込んだ名前とはどのようなものでしょうか。 命名するポイント…
「簡潔さ」と「安心」のどちらが大切か、またどのようにその判断を行うか 以下のコードを見比べて見ましょう。 # A n = 3 puts n % 2 == 0 ? "#{n}は偶数です" : "#{n}は奇数です" #=> 3は奇数です # B n = 3 if n % 2 ==0 puts "#{n}は偶数です" else puts …