カテゴリー : 変数名の命名規則

 

1文字の変数名

変数名には、「名詞・名詞句または形容詞」を使用することが原則ですが、ローカル変数でかつ狭いスコープ(20~30行くらいまで)で使用する変数には、1文字の変数名を許可します。
 
以下によく使われる1文字の変数名を例示します。
 
i:for文のループ変数
j:for文のループ変数(2重ループ)
k:for文のループ変数(3重ループ)
3重ループ以上は「メソッドの抽出」などのリファクタリングをした方がよいでしょう。
 
n:int型を格納する一時変数
c:char型を格納する一時変数
s:string型を格納する一時変数
b:bool型を格納する一時変数
o:object型を格納する一時変数
 
x:X座標を格納する一時変数
y:Y座標を格納する一時変数
z:Z座標を格納する一時変数
 

単語連結法 (of language)とは

単語連結法とは、変数を「主要部-修飾部-クラス」の形式で表現する記法です。
 
たとえば「CUSTOMER-OFFICES-ID」という変数名は「顧客の事業所のID」という意味になり、主要部に変数名で表したい実体(CUSTOMER)、修飾部に補助的な内容(OFFICES)、クラスは前述したハンガリアン記法のようにデータ型(ID)を設定します。
 
主観では汎用機、COBOLでよくつかわれる表記だと思います。
 
このサイトでは、もちろん単語連結法の変数名も作成できます。
 
 
例:サフィックスに「-ID」を指定し、文節区切り文字に「-」を指定
 
 
「顧客 事業所(こきゃく じぎょうしょ)」⇒「CUSTOMER-OFFICES-ID」
 
※「漢字・ひらがな・カタカナ ⇒ 英語」にて変換。
 

ハンガリアン記法(hungarian notation)とは

ハンガリアン記法とは、変数の先頭や末尾に特別な識別子を付けて、他の人がその変数を見たときにデータ型や使用方法・スコープなどを分かりやすくするための記法です。
 
C言語のポインタを「p」または「lp」から始める、文字列を「s」から始めるなどが有名ですが、私はこれほどプログラマに嫌われている記法を見たことがありません。
 
理由はシンプルに「型が変わった場合に変数名を全部直さなきゃならないから」につきると思います。
 
今でこそVisual Studioのリファクタ機能で一括置換が可能ですが、当時は「変数名を変える」⇒「ビルド」⇒「エラーになったところを全部直す」という手順を踏まなければならず、コアとなる変数名が変わったりしたものなら居室のあちこちから阿鼻叫喚が聞こえることも珍しくありませんでした。
 
そんな悪名高いハンガリアン記法ですが、設計時点では有用です。たとえば「これはテキストボックスだよ」を表現するときには「txt」を先頭に付ける、ボタンの場合は「btn」を付けるなどのルールを決めておけば、プログラマが迷うことはありません。
 
このサイトでは、プレフィックスやサフィックスに識別子を指定すると、ハンガリアン記法の変数名を簡単に作れます。
 
 
例:プレフィックスに「txt」を指定した場合
 
 
「電話番号(でんわ ばんごう)」⇒「txtDenwaBango」
 
 
例:サフィックスに「Text」を指定した場合
 
 
「電話番号(でんわ ばんごう)」⇒「DenwaBangoText」
 

スネークケース(snake case)とは

スネークケースとは、変数名を構成する単語をアンダースコア(_)で連結していく形式です。
 
私がC言語を習い始めたころは、スネークケースで表記すのが一般的でした。
 
たとえば「アップルパイ」を英語で表記すると「apple pie」になりますが、スネークケースでは「apple_pie」と表記できますので、英語表記の間隔を変えることなく変数名を命名できます。
 
このサイトでは、文節区切り文字で「_」を指定すると、スネークケースの変数名を簡単に作れます。
 
 
例:「アップルパイ(あっぷる ぱい)」⇒「apple_pie」
 
※「漢字・ひらがな・カタカナ ⇒ 英語」にて変換。
 

パスカルケース(pascal case)とは

パスカルケースとは、変数の先頭を大文字の単語から始め、文節ごとに大文字で始めた単語を連結していく形式です。
 
C#ではプロパティ名やメソッド名をパスカルケースで表記するのが一般的です。
 
このサイトでは、変換方法で「大文字始まり文節ごと大文字」を指定すると、パスカルケースの変数名を簡単に作れます。
 
 
例:「電話番号(でんわ ばんごう)」⇒「DenwaBango」
 
パスカルケースはアッパーキャメルケースとも呼ばれます。
 

キャメルケース(camel case)とは

キャメルケースとは、変数の先頭を小文字の単語から始め、文節ごとに大文字で始めた単語を連結していく形式です。
 
C#ではローカル変数やフィールド名をキャメルケースで表記するのが一般的です。
 
このサイトでは、変換方法で「小文字始まり文節ごと大文字」を指定すると、キャメルケースの変数名を簡単に作れます。
 
 
例:「電話番号(でんわ ばんごう)」⇒「denwaBango」
g h T
 7,692 Total Views