リーダブルコード

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

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

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」が選択できるようになっているため,あまりタイピング量を気にして命名する必要もありません。それよりも後から見た人が理解できるようにする方が大事です。

リーダブルコードC#

C#を正しい3層構造で造れてますか?

非売品コースを受け取る

#01_はじめに
#02_プロジェクトの作成
#03_右に長いコードを書かない_隣のとなりまでしか訪ねない
#04_隣のとなりまで_右スクロールより縦スクロールの方がいい
#05_IFとELSEがある時は肯定系をIF否定形をELSEにする
#06_比較する時は変数を左_定数を右にする
#07_複数の比較を1回のif文でやらない
#08_booの比較でTrueやFalseを書かない
#09_否定の否定はしない
#10_型チェックはasを使う
#11_メソッドはできるだけ早く抜ける_返却する値を無駄に変数に入れない
#12_対象外の時はすぐに抜ける
#13_都合が悪いケースはガードする
#14_必ずやりたい処理はfinallyを使う
#15_比較演算子はできるだけクラスにさせる
#16_ifの中括弧の省略はしない
#17_if文のリーダブルコードまとめ
#18_名前の付け方
#19_意図が明確な名前を付ける
#20_名前は素直に付ける_連想ゲーム的な名前を付けない
#21_1つの事しかしていなければ短い名前でも理解できる
#22_長いクラス名の扱い方
#23_単数形と複数形で表現する
#24_対になる言葉の組み合わせを決めておく
#25_業務で使う名前は統一する
#26_名前を統一するための辞書ツール作成
#27_メンバー変数にアンダーバーを付ける
#28_ハンガリアン記法を使わない
#29_メソッド内の変数をメソッド最初に全部宣言しない
#30_メソッド内の変数は直前に宣言する
#31_ループの変数はループ内で宣言する
#32_変数を使いまわさない
#33_boolの戻り値はどちらがTrueかをわかるようにする
#34_解放が必要なオブジェクトにはusingを使う
#35_varを推奨する場合
#36_メソッド名の付け方
#37_voidとFunctionを意識する
#38_インテリセンスを意識した名前にする
#39_生成メソッドはCreate_型変換はToを使う
#40_無駄に変数に入れて返却しない
#41_重複をなくす
#42_リージョンで区切らない
#43_アクセス修飾子とsealedを付ける
#44_クラス名はソリューションエクスプローラーで並べることを意識する
#45_クラス名は名詞か名詞句で命名する
#46_クラス名で継承元や特性を表現する
#47_メソッド内にコメントを書かない
#48_分かりづらい部分はメソッド化をしてメソッド名で想いを伝える
#49_コードを読んだ人が「えっ?」と思うことが予想される場所にだけコメントを付ける
#50_コメントで悪いコードを取り繕うことはできない
#51_未実装機能はTODOコメントを書く
#52_リーダブルコードまとめ