/note/tech

読みやすいコードを書く

もしもこの記事を読むのが面倒であれば、以下の5つだけを覚えておけばよい。

1. ひとつの処理の単位はディスプレイで一度に表示できる範囲に収めること[1]。

2. 意味を持つデータには適切な名前をつけて変数化すること。

3. 意味を持つ処理には適切な名前をつけて関数化すること。

4. 同じ役割・意味を持つ変数や関数には一貫した名前をつけ、異なる役割・意味を持つ変数や関数には同じ名前をつけないこと[2]。

5. 2, 3, 4 を守ってもコードに反映されない「そのコードを書いた意図」はコメントとして残すこと。