Javascript コードの書き方
プログラムのコードが読みやすくないと内容を素早く正確に理解できるので修正もしやすくなります。不具合の起きにくいプログラムを書くことができます。
コメントを付けて理解しやすくする
プログラムはコンピュータの言葉なので人にとって読みやすいコードを意識して書かないと自分で書いたコードでさえ何のために記述したプログラムなのか忘れてしまうことがあります。そのため読みやすさを意識してコードを記述することが重要になってきます。最も手軽にできることとしてはプログラム中にコメントを記述することができます。Javascriptではプログラム中に//と記述すると、その行の行末までがプログラムとして実行されないコメントになり自由にメモを残すことができます。また、複数行のコメントを残したい時は/*から*/で囲んだ範囲がコメントになります。人間の言葉であるコメントは読みやすいだけでなくプログラムを読むだけではわからない仕様なども残すことができます。
わかりやすい名前を付けよう
コメントを用いなくても読みやすいコードにすることができます。例えば変数名に意味のある言葉を使えば、その変数名から何をしているのか想像することができます。BMIの計算のコードの変数名を意味のあるものに変更してみました。意味をりかいしづらかったa、b、cの変数もBMIを重さweightと高さheightを元に計算しています。
変数名を記述するデータに合わせてわかりやすくする
1 2 3 4 5 |
// BMIの計算 let a = b / (c * C); // BMIの計算 let bmi = weight / (height * height); |
インデント、スペース、改行の工夫で読みやすくする
コメント、変数名以外で重要なのがインデント、スペース、改行の工夫です。インデントは行頭の余白部分のことで階層でインデントをそろえることでコードが読みやすくなります。例えば以下のコードでは{から}の間に同じ階層として順に実行されるのですが無秩序な状態では秩序ある状態に比べてインデントがずれているので読みにくいです。またスペースも無秩序は状態では間が空きすぎていたり縦に見たときに=がそろっていなかったりと、なんとなく理解しにくいものです。Googleが定めたコーディング規約に沿ってインデントは2文字、値と演算子の間には半角スペースを1つ入れています。また=の位置をそろえるなどこうすると読みやすくなります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
//無秩序なコード記述 function greet() { let message= 'こんにちわ'; let name = '金太郎'; alert(message +name) ; } //秩序のあるコード記述 function greet() { let message = 'こんにちわ'; let name = '金太郎'; alert(message +name) ; } |