神戸プログラミングアカデミーのブログ

「未経験から」「スキルアップ」「起業を目指す」無料で学べる神戸のプログラミング学校&学習コミュニティ

コーディング規約と命名規則について


コーディング規約

コーディング規約とは

プログラミングを記載していく際に決めるルールのことです。 ほとんどのプロダクトの開発はチームで開発していくため、チーム内でルールを決めておくことで、他の人が書いたコードを理解しやすくなり開発効率があがります。

具体例)

  • ソースコードのファイル名
  • コードの変数や関数の名前の付け方(命名規則
  • コメントはどのくらい書くのか?
  • 一行に書いていい文字数

等です。

命名規則

コーディング規約の中で、変数や関数の名前の付け方を統一することは、チーム開発をしていても個人開発をしていても、ソースコードの読みやすさに直結します。

命名規則は、

チーム・プロダクトで決める > 言語で決める > 個人で決める

という優先順位で決定しましょう。

たまに、チーム開発で自分のルール(自分が好きな命名規則)を押し通す人がいますが、こういう人はとても迷惑です。 みなさんはそんなプログラマにはならないでください。

ここでは具体的な命名規則を紹介します。

アッパーキャメルケース
GetUserName()
ローワーキャメルケース
getUserName()
スネークケース
get_user_name()
ケバブケース(チェーンケース)

-はプログラム言語内で マイナス と同じ意味を持つため、コード内で使われることはありません。 ファイル名や、URL、HTMLタグで使われます

user-name

言語ごとの習慣

命名規則は言語ごとに習慣があるので、それを紹介します。

言語 関数 変数 定数 クラス名
JavaScript ローワーキャメルケース ローワーキャメルケース 大文字スネークケース アッパーキャメルケース
C/C++言語 スネークケース スネークケース 大文字スネークケース アッパーキャメルケース
マイクロソフト系(C#, C++) アッパーキャメルケース ローワーキャメルケース 大文字スネークケース アッパーキャメルケース
Python スネークケース スネークケース 大文字スネークケース アッパーキャメルケース
Ruby スネークケース スネークケース 大文字スネークケース アッパーキャメルケース