Naming Conventions (命名規則)
識別子[しきべつし](変数名や関数名などのこと)の命名規則を守ることで、コードのメンテナンスや統合、グループ開発などがスムーズに行えるようになります。
数ヶ月前に作ったコードに変更や追加をする場合に便利です。
例えば「sName」はBioWareの命名規則に従った「文字列型」の「(誰かの)名前」を入れるための変数だというのが容易に分かります。それが「__NAME」とか「name」、「Name」もしくは他の派生語だった場合のように、コードの中を探し回る必要がなくなります。
他の人が作ったソースコードを自分のモジュールに組み込むとき、その両方が標準の命名規則に従っていれば大抵その組み込みは簡単に出来るでしょう。例えば自分のモジュール内にセットされたある変数に、他の誰かが作ったNPCが反応するようにしたい場合、そのNPCのスクリプトを一部変更することになるかも知れないのです。
グループ開発では1セットの命名規則および標準コーディング方法を全てのメンバーが守ることが特に大切です。そうでなければ混乱と無秩序に陥る結果になります。
変数名はその型を表す接頭辞[せっとうじ](プレフィクス)に名前を続ける形で書くべきでしょう。
接頭辞は以下の表の通りです。
Type (型) | Prefix (接頭辞) | Example (例) |
action | a | aKill |
effect | e | eConPenalty |
event | ev | evAttacked |
float | f | fResult |
int (数値を格納する場合) | n | nAge |
int (boolean:論理値を格納する場合) | b | bIsSpell |
location | loc | locJumpTo |
object | o | oPC |
string | s | sName |
struct | str | strPerson |
talent | t | tSkillHide |
vector | v | vVelocity |
author: Charles Feduke, JP team: ohtsuki
Send comments on this topic.