リーダブルコードの第一歩

なぜ美しくなければいけないのか？

優秀な人は例外なく美しい

冒頭にも申し上げましたが、コードはその人の習熟度合いを如実に表します。

どんなに納期が迫っていて時間がなくても、優秀な人のコードは必ず美しいものです。

例外はありません。

読みやすい

何が美しいコードなのか？

ぱっと見て読み易ければ、そのコードは美しいです。

見やすいコードであれば、メンテナンスとして改修もしやすくなります。

癖づく

もちろん誰しも最初に書いたコードはゲロまみれです。

だんだん聖水に近づけていくのが、必ず通らなければいけない努力となります。

これは癖づけて、毎秒考えながら行うしか身に付ける方法はありません。

そのために、他の人のコードを見て、この記事を見て、参考にして下さい。

１ヶ月後に振り返った時自分のコードがゲロに思えたら、それはあなたが成長している証です。

もし聖水に見えたのなら、あなたはこの１ヶ月で成長していないでしょう。

具体的に何を気をつければいいのか？

変数・関数名

プログラムに出てくる無数の変数と関数の命名方法は、まさに鍵を握っていると言って差し支えありません。

以下は、必ず守って下さい。

• 変数には意味を持った名前をつける
• 何を付けたらいいかわからないなら、codecを使う
• もし変数に意味を持たせられないなら、その変数は使う必要がない
• ローマ字を使わない
• 15文字以上と長くしない
• 数字を使って連番の変数を使わない

これも誰しもが指摘されて直している道です。

特殊技能でも何でもありません。

ただの癖です。

関数のスコープ

現在のプログラミング技能で必須のスキルと言えば、オブジェクト指向プログラミングです。

つまり、各処理を部品化して細かく分けて管理をするものです。

長すぎる関数は、読みづらいですし共通処理を切り出しにくくなります。

以下を遵守して下さい。

• 意味を持つ処理ごとに関数で括る
• それぞれの関数の行数は20行まで
• 20行を超える関数になった場合、中の処理を切り出す
• 関数が多すぎるファイルになった場合は、中の処理を別ファイルに切り出す

宣言方法

変数宣言時は、多くのトラブルを招きます。

あらかじめ把握しておくことで、多くのトラブルを回避することができます。

• グローバル変数は、ファイルの1番上に書く
• 固定値を入れるときは、固定値を宣言する専用のフォルダに格納する(constantsなど)
• 再宣言・再代入は基本的には許さない
• 多くの処理を詰め込みすぎない

JavaScript

ここではJavaScriptでの注意点を細かく書いていきます。

以下も同様に必ず遵守して下さい

• 行末には , ; などの区切り文字をつける
• for()は使用せず、map, forEach, filterなどを使用する。ここを参照する
• varは使わない
• 文字列の結合は、`${}`を使用する

美しいの先にあるもの

他人に感謝されるコードに

あなた自身が綺麗なコードを書いていれば、他の人は自然とあなたの真似をします。

コードの真似は案外簡単なものです。

他の人の教科書に、今日からなりましょう。

コードレビューもスイスイ

上位者にコードをレビューしてもらう機会があるなら、コードは厳しく見てもらいましょう。

改善点はいずれなくなります。

むしろ、ありすぎる場合、細かい指摘点は無視されてしまいます。

結果として、上位者の細かいテクニックは聴けず終わってしまいます。

明らかな機会損失です。

おわりに

私の上司はコードレビューがかなり厳しく、以前は指摘点が多すぎてゲンナリする毎日でした。

ただ、今となってわかります。

汚いコードを見ると、ゲンナリどころか蕁麻疹が出ます。

もちろん、改善しようとする意思が見えた場合、それは感じません。

コードには意思が現れます。

さらなる綺麗なコードを求めると、性格や態度まで変わっていきます。

ぜひ綺麗なコードを書く習慣を付けて下さい。