「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典イメージぴよ画像「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典

命名規則

pointこの用語のポイント

point名前の付け方ルールだよ

pointプログラミングの話で出てくるよ

point複数人でプログラミングするときに話題に出ることが多いよ

スポンサーリンク

簡単に書くよ

命名規則(読:メイメイキソク 英:naming convention)とは

お仕事とかでプログラミングをするときに出てくるかもしれない用語のひとつ
であり

例えば「複数の単語をつなぐときは『member_id』のように『_』でつなぎなさい」のような、変数とか関数に名前を付けるときに守らないといけないルールのこと
です。


image piyo

詳しく書くよ

サクっと一言で説明すると

名前の付け方ルール

をカッコつけて言ったのが「命名規則」です。
主に、プログラミングの話で出てきます。

命名規則

命名規則は

1.複数人で1つのプログラムを作る
2.作った人とは別の人がプログラムを修正する可能性がある


ときに重要です。

例えば、そうですね。

ピヨ太君とピヨ子さんとピヨ太ママで一緒に1つのプログラムを作ることにしました。

命名規則2

3人とも、それなりに経験を積んだプログラマです。
手分けしてソースコード(人間語で書いたプログラムの元ネタ)を書くことにしました。

命名規則3

それぞれが作る処理は

ピヨ太君:渡した数字に1を足す処理をする関数
ピヨ子さん:渡した数字に2を足す処理をする関数
ピヨ太ママ:渡した数字に3を足す処理をする関数


です。
処理の内容がショボいのは見なかったことにしてください。

ピヨ太君は、自分の担当の処理を以下のように書きました。

function keisan_tasu_1(ireta_atai){
    kaesu_atai = ireta_atai + 1;
    return kaesu_atai;
}


命名規則4

ピヨ子さんは、自分の担当の処理を以下のように書きました。

function Add2(inputNum){
    retValue = inputNum + 2;
    return retValue;
}


命名規則5

ピヨ太ママは、自分の担当の処理を以下のように書きました。

function func-add3(num-param1){
    num-ret-value = num-param1 + 3;
    return num-ret-value;
}


命名規則6

3人の書いた処理を合体させたところ、以下のような見た目になりました。

function keisan_tasu_1(ireta_atai){
    kaesu_atai = ireta_atai + 1;
    return kaesu_atai;
}

function Add2(inputNum){
    retValue = inputNum + 2;
    return retValue;
}

function func-add3(num-param1){
    num-ret-value = num-param1 + 3;
    return num-ret-value;
}


命名規則7

いかがでしょう。
なんとなく統一感がありませんよね。

命名規則8

3人ともベテランプログラマです。
書いた処理は、ちゃんと動きます。

ですが、見た目がバラバラなので、修正したりするのが大変そうです。
自分が書いた処理ならともかく、他の人が書いた処理に手を入れることになったら名前の付け方に違和感を覚えるでしょう。

命名規則9

あるいは、ケンカになる可能性だって、あります。
ピヨ太君がピヨ子さんの書いた処理を見て「単語の区切りが見にくいなぁ」と思うかもしれません。
ピヨ太ママがピヨ太君の書いた処理を見て「初心者みたいな名前の付け方をしているわね」と思う可能性もあります。

命名規則10

そんな鬱陶しい諸々を避けるために、あらかじめ「名前を付けるときは、このルールを守って付けてね」なルールを決めておくのです。
そうすれば、ある程度は統一感のある名前になります。

この「名前を付けるときは、このルールを守って付けてね」なルールが命名規則です。

なお、具体的にどんなルールなのかは現場によります。
先輩とか上司に聞いてみてください。
ある程度以上の規模のシステム開発であれば、事前に決められた命名規則があるはずです。

……ない場合もあるけど。

命名規則がない場合は、そのシステムの別の処理を見せてもらったり、過去に作ったやつとかを見せてもらって、なんとなくの系統を把握しておくと「おっ、こいつはデキるな」感を演出できると思います。

以上で命名規則の説明は終わりですが、ついでなので「コーディングルールコーディング規約」にも触れておきます。
余裕がある方は頑張って読んであげてください。
脳みそから煙が出そうな人は無理する必要ありません。
ゆっくり休んでください。

休め

あっ、読んでくださるのですね。
ありがとうございます。

それでは、いってみましょう。

コーディングルール(コーディング規約)は「ソースコード(人間語で書いたプログラムの元ネタ)の書き方ルール」です。

命名規則11

ソースコードというのは、同じ処理をさせる場合でも いろいろな書き方ができます。
例えば、とある処理をするプログラムの作成をピヨ太君とピヨ子さん、アクマ君の3人にお願いしたとしましょう。

ピヨ太君は以下のように書きました。

if(onaka == "空いた"){
    print "腹減った";
}else{
    print "満腹だ";
}


ピヨ子さんは以下のように書きました。

msg = (onaka == "空いた") ? "腹減った" : "満腹だ";
print msg;


アクマ君は以下のように書きました。

a="満腹だ";
if(onaka == "空いた") a="腹減った";
print a;


パッと見では、みんな書いてあることが違うように見えます。
ですが実際には、これが全部同じ動きをします。

そんな3人が一緒になって1つのソースコードを書いたら、どうなるでしょうか。
きっと、それぞれがオリジナリティを発揮して、統一感に欠けるものになるでしょう。
後から読み返すのが大変そうですよね。

この個人個人の書き方の癖を消して全体として統一感を持たせるためのローカルルールがコーディングルールです。
「名前の付け方は、こんな感じにしなさい」「こんな処理を書くときは、こんな書き方をしなさい」などソースコードを書く上でのルールが事細かに書かれています。

コーディングルールに沿って書けば、誰が書いても同じような書き方になります。
複数人で書いても1人が書いたような見た目になり、後から見返すのが楽になる理屈です。

命名規則は、コーディングルールの一部として定義されているのが一般的です。
気が向いたら、セットで覚えてあげてください。

コーディングルール:ソースコードの書き方ルール
命名規則:名前の付け方ルール


です。


image piyo2

一言でまとめるよ

まぁ「命名規則」って単語が出てきたら「名前の付け方ルールなんだな~」と お考えください。

一番上に戻るよ
スポンサーリンク
書籍画像017
書籍画像018


書籍画像
わわわ説明術コラム
宣伝だよ
「分かった!」と思わせる説明の技術 知識ゼロの相手にも伝わるようになる本
つくって、壊して、直して学ぶ Kubernetes入門
マンガでわかるITパスポート