コーディングルール

プログラムは、見やすくすることでエラーを減らすことや発見するための助けになります。時間が経った後にプログラムを見たときに、その振る舞いや意図がわかるかどうかは、プログラムの保守に密接につながります。

プログラムにエラーはつきものです。エラーを以下に少なくし、長期間保守できるかどうかが、そのプログラムの良し悪しを決めます。

ここでは、できる限り見やすいプログラムを書く習慣をつけるため、次のルールを守ってください。守っていないプログラムは添削等はしません。

インデントをつける

プログラムにはブロック（文の集まり）があります。ブロックのレベル（深さ）、構造がひとめでわかるように、インデント（字下げ）を行います。インデントは空白やタブ（Tab）を入れて同一ブロックのレベルを揃えます。レベルが一つ深くなると、タブや空白（２または４文字）を入れます。逆にブロックが終了したときには、前のレベルに合わせます。

code:indent.js

/*

インデント、コメントの例

strict モードを使う

*/

'use strict'

function isOdd(number){ // ブロック開始 '{' 終了は '}'

//関数の本体, number が奇数のときは 'true' そうでなければ 'false' を返す。

let a = number % 2; // number を２で割ったその余りを計算 %は剰余演算子

if ( a == 1 ) { // 余りが１なので、奇数、ブロック開始

return true;

} else { // else はそれ以外の構文、ブロック終了し、次のブロックが開始

return false;

}

} // 関数ブロックの終了

function setup() {// setup関数の開始

createCanvas(400, 400);

console.log(isOdd(5)); // 結果の確認

console.log(isOdd(10));

}

カッコの対応をわかりやすくする

コメント（注釈）をつける

コメントは、他の人がプログラムを読んだときに、作者の意図を読み取るために必要です。これは自分しか使わないと思っても、自分自身も時間経過とともに忘れていきますので、そのプログラム用途や意図を思い起こす助けとなります。

あまり、書きすぎることは煩わしが増えてしまうこともあるので、的確なコメントを書くようにしましょう。

関数名、変数名は直感的なものにする

マニュアルや、他者から見える関数名や変数名は直感的でわかりやすいものにしましょう。特にスペルは正しく使いましょう。わからないときは辞書を引いて確認してください。後々まで残りますので、恥ずかしい思いをすることがあります。（また、コンピュータはスペルミスを絶対に許してくれません。）

関数名、変数名はできる限り英数字を使いましょう。（日本語などのUTF-8の文字も使えますが、初心者には推奨しません。）