命名規則について

2019/04/17

スムーズに開発を進めるためにも命名規則に沿って名前をつけることは大事です。

Laravelでは他のフレームワークに比べると命名規則は厳しくないと言われています。

しかし、いくつかの作法があるのも事実です。

Laravelをはじめて学習する方は最初にここを抑えておくと、プロジェクト全体に統一感が出ていいかもしれません。

今回は命名規則についてのエントリーです。

 
INDEX

 

複数の単語を組み合わせる場合

プログラミングにおいて複数キーワードの名前の付け方としてアッパーキャメル記法ローワーキャメル記法スネーク記法という記述方法があります。

 

アッパーキャメル記法

先頭を大文字で書き始め、複合語のスペースをなくし要素の先頭を大文字にします。

(※パスカルケースとも呼びます。)

[例] user + parameter ⇒ UserParameter

文字のラインが凸凹になっており、ラクダのこぶのように見えることからキャメル記法と名付けられました。

 

Laravelでの使用方法

種類 単数/複数
モデル 単数形 UserMsg.php
AccessRanking.php
コントローラ どちらもOK UserMsgController.php
AccessRankingController.php

 

ローワーキャメル記法

先頭を小文字で書き始め、複合語のスペースをなくし要素の先頭は大文字にします。

アッパーキャメルをパスカルケースと呼ぶ人はローワーキャメルを単にキャメルケースと読んだりします。

[例] user + parameter ⇒ userParameter

 

Laravelでの使用方法

種類 単数/複数
メソッド userProfile()
postRegister()

 

スネーク記法

単語と単語の区切りにアンダースコアを使う記述方法をスネーク記法と呼びます。

[例] user + parameter ⇒ user_parameter

文字のラインがくねくねした蛇に見えることからスネーク記法と名づけられました。

Laravelではメソッドの名前やマイグレーションファイルの名前、DBのカラム名を付けるときに使用します。

 

Laravelでの使用方法

種類 単数/複数
テーブル名 複数形 access_rankings
user_profiles
変数名 $user_name
$college_name_current
Bladeのファイル名 user_admin.blade.php
user_profile.blade.php
マイグレーションのファイル名 単数形 create_user_table.php
add_pref_to_users.php

 

事例

例えばログインの履歴を残すテーブルを作る場合は以下のように全て名前が決まります。

テーブル名 login_records 複数形、スネークケース
モデル名 LoginRecord 単数形、アッパーキャメルケース
コントローラ LoginRecordsController (今回は)複数形、アッパーキャメル

特にテーブル名とモデル名は規則に沿って名前をつけないと紐づきません。

 

命名規則に関しては以上です。

本庄マサノリ

仕事でLaravelを使っています。気づいたことや新しい発見など情報を発信していきます。メールはこちら

 

-基礎知識