命名に関する規約
配列を表す変数の変数名は複数形にする。
NG
$name = array('');
OK
$names = array('');
単複同型の英単語は配列を表す変数として使用しない。
関数名は英語の文法を意識してつける。
NG
function ok(){}
function metadata(){}
function end_tag(){}
var $done;
var $bad;
if(ok($next_record) && !$done) { # okってどういう意味? 何が終わった(done)の?
while (metadata($next_record)) { # metadata が存在する? 定義されている? 真?
push($metadates, get_metadata_for($next_record));
if (end_tag($next_record)) break; # end_tagがどうしたの?
}
}
else {
$bad = true; # 何が悪い(bad)なの? どうbadなの?
}
OK
function is_valid(){}
function metadata_available_for(){}
function has_end_tag(){}
var $loading_finished;
var $has_found_bad_record;
if(is_valid($next_record) && !$loading_finished) {
while (metadata_available_for($next_record)) {
push($metadates, get_metadata_for($next_record));
if (has_end_tag($next_record)) break;
}
}
else {
$has_found_bad_record = true;
}
大文字小文字について
単語の区切りは「_」を用いる。
NG
var $userName;
function getPlayerCount(){}
OK
var $user_name;
function get_player_count(){}
省略について
極力省略はしない。
NG
var $uid;
OK
var $user_id;
省略するときは頭文字を使う。
NG
var $lngh;
OK
var $length;
var $len;
ただし、慣用的に用いられている省略形はそれを使う。
NG
var $mess;
OK
var $message;
var $msg;
var $mesg;
NG
var $sou;
OK
var $source;
var $src;
自分たちがネイティブではないため慣用的に用いられているかどうかの判断が難しいところなので、慣れていくしかない。
private 関数は「_」で始める。
NG
private function is_valid() {};
OK
private function _is_valid() {};