C#リーダブルコード #18_名前の付け方

当サイトではアフィリエイト広告を利用しています。

リーダブルコード
Subway Station in Munich, Germany. Train coming in. Strong Motion Blur on Train and People, no recognizable Persons.

それではここからは名前に関するお話をしていきます。

1.1   わかりやすい名前にする

まずは「わかりやすい名前にする」ということですね。クラス名,メソッド名,変数名,すべてにおいてそうですが,わかりやすい名前を付けるということを心掛けてください。どういった名前がわかりやすいかというのは,ある程度個人の主観にも関係しますが,まずは「気取らない」ということです。「素直」に命名するというのが1つです。

1.2   英語で命名する

「素直に気取らず命名する」ということと,あとは基本的にはすべて「英語」で命名するというのがC#の基本です。.NETが世の中に出る前のVB6時代以前などは,日本語をローマ字にして命名していることもありましたが,例えば金額なら「Kingaku」などと命名していた時代もありますが,現在は「Price」などの英語で命名するのが基本です。

1.3   略さない

前述のとおり,クラス名等すべては英語で命名していただきたいのですが,英語にすると,日本語にくらべて文字数が長くなることがあります。電力発電であれば,「ElectricPowerGeneration」となり24文字程度ありますが,この程度なら全然OKですよね。何文字までという決まりはありませんが,40文字程度なら問題ないと思います。エディターで見たときに,横スクロールしないと読めないほど長い名前は困りますが,40文字以下くらいなら問題ないでしょう。それよりも略語にして意味が分からなくなる方が読みづらくなるので,常識的ではない言葉で略すのはあまりよくありません。例えばDababaseをDBとか,CompactDeskをCDとするように,常識的な略し方,むしろ世の中ではそう呼んでいるというものを略語で表現するのはOKですが,「ElectricPowerGeneration」を「ElePG」とか,勝手に略語を作って命名するのは,他のプログラマーの混乱を招くため,おすすめできません。また,文字数が長いとタイピングがしんどいと思われる方もいるかもしれませんが,VisualStudioではインテリセンスの機能があり「.Ele」などど入力すると,「.ElectricPowerGeneration」が選択できるようになっているため,あまりタイピング量を気にして命名する必要もありません。それよりも後から見た人が理解できるようにする方が大事です。