【プログラミング】名は体を表す！命名規則に関するポイント
rnrn_toukou_iY
こんにちは。Itoop（アイティープ）の松永です。
11月も3分の2が過ぎ、今年も残りわずかとなってきました。気温も一気に下がり、寒い日が続きますね。
寒さ対策をしながら残りの期間も過ごしていきましょう。
さて、今回はプログラミングに関するお話です。私が前回書いた記事でシンプルなプログラムを書く要因の1つとして、「命名規則の遵守」というものがありました。
その内容として「名は体を表す」ということを書いていましたが、名前を読むだけで意味が理解できるようにすることはとても重要です。
他にも意識すると良いことは多数あるため、今回は「命名規則」について書いていきます。
名称に規則を持たせる意図とは
関数や変数にわかりやすい名前を付けることは、コードの可読性と保守性を大幅に向上させます。
コードの可読性と保守性はプロジェクトの進捗にも大きな影響を与えますが、多人数での開発になれば、その影響はより大きくなります。
可読性と保守性の向上は、プログラマー同士のコミュニケーションコストも下がり、プロジェクト全体の成功につながるでしょう。
それくらい重要であるということが伝われば幸いです。
意識するべきポイント
実際に何を意識すれば良いかについて、私がよく言ってきてもらったことを重点的に書いていきます。
- 意味のある名前を付ける
コードを読む人が、変数や関数の役割を直感的に理解できる名前を付ける。
良い例: calculateTax(),userName
悪い例: doSomething(),temp - 長すぎず短すぎない長さにする
適切なバランスを見極め、短い単語で具体性を持たせる。
良い例:totalPrice
悪い例: t（短すぎる）、thisIsTheTotalPriceOfTheItems（長すぎる） - 関数名は「動詞 + 名詞」の形式で書く
「動詞 + 名詞」で処理の内容を具体的に示す。
良い例: fetchData(),updateUserProfile()
悪い例: data(),update() - 略語は用いない
解釈のズレが起きる要因となるため、利用する場合はプロジェクト全体で定義する。
良い例:databaseConnection
悪い例:dbConn - 単数形と複数形を正しく使う
配列やリストには複数形を、個別の値には単数形を使用します。
良い例: user（単一ユーザー）、users（複数ユーザー） - 業界標準に従う
プログラミング言語やフレームワークごとの命名規則を遵守する。
スネークケース（snake_case）、キャメルケース（camelCase）、パスカルケース（PascalCase）の使い分けなど - コメントが必要になる名称にはしない
名前に十分な情報を含めること。
良い例:validateEmailAddress()
悪い例: process()（「何を処理しているのか」が不明）
まとめ
ざっとですが、私が過去によく言われてきたことをまとめました。コーディング規約が設けられているプロジェクトであれば、この辺りはルール化されているはずです。
案件や使っている言語によって変わってくるため、そこはそのプロジェクトに合わせながら、自分以外の人が読む前提で、配慮したプログラムが書けると良いですね。
この命名規則に関しては調べれば様々な記事がヒットするくらいに大事とされていますので、本日の記事を読んだ方のスキルアップに繋がれば幸いです。
ーーーーーーーーー
【株式会社ゆいまーる（社長：島袋尚美）】
『若者のエンパワーメントを通じて、日本を元気に』を理念に、Itoop（ITコンサルティング）、JUNGLE BREWERY（クラフトビール）、キャリア支援など複数事業を展開。
HP▷http://yuima-ru-tokyo.com/
【社長の経歴】
島袋尚美（Shimabukuro Naomi）
沖縄出身。筑波大学卒業後、システムエンジニアとして証券会社に入社。
日本IBMに転職し、ダブルワークで立ち上げの準備を開始。
28歳で独立、2016年に株式会社ゆいまーるを設立。
その後国際結婚を経て、現在は子育てをしながらママ社長として、複数の事業を手掛ける。
