BETA

Laravel関連 (個人的)命名規則

投稿日:2019-06-25
最終更新:2019-12-27

Laravelとその周辺の命名規則を個人的なものも含めてまとめたメモ

ソースコード

モデル名 EditUser (単数形、パスカルケース)
コントローラー名 EditUsersController (単数形か複数形、パスカルケース)
ビュー edit_users/create.blade.php (単数形か複数形、スネークケース)

  • コントローラーとビューには同じ規則を適用

データベース

テーブル名 edit_users (複数形、スネークケース)
カラム名 second_name (スネークケース)
外部キー edit_user_id (モデル名_id)
中間テーブル post_tag (モデルのアルファベット順、スネークケース)

edit_users (id int, name string, second_name string)  
posts      (id int, body string, edit_user_id int)  
tags       (id int, name string)  
post_tag   (id int, post_id int, tag_id int)  

PSR-2

クラス名 EditUsersController (パスカルケース)
メソッド名 createEditUser (キャメルケース)
変数 $edit_user (スネークケース)
定数 MAX_USER (大文字 + _)

  • 名前は長くても20文字程度

Javascript

オブジェクト・関数・インスタンス (キャメルケース)

var thisIsMyObject = {};  
function thisIsMyFunction() {}  
var user = new User({  
  name: 'Bob Parr'  
});  

クラス・コンストラクタ (パスカルケース)

function User(options) {  
  this.name = options.name;  
}  

var good = new User({  
  name: 'yup'  
});  

定数 MAX_USER (大文字 + _)
プライベートメンバ _internalFunction (_ + キャメルケース)
イベントハンドラ onDialogAccept (on + パスカルケース)

HTML

class属性 CSSで使用するのでケバブケース
id属性 JavaScriptで使用するのでキャメルケース
data-*属性 JavaScriptで使用するのでキャメルケース

その他

ルート http://abc.de.jp/play-histories/{play_history} (ケバブケース)

  • 変数はスネークケース
  • 基本は小文字で統一

参考

https://laraweb.net/knowledge/942/
https://qiita.com/Takashi_INOUE/items/41d9fedaad1ff338cada
http://snowdream.github.io/javascript-style-guide/javascript-style-guide/jp/naming-conventions.html
https://www.asobou.co.jp/blog/web/url-optimisation
https://qiita.com/itagakishintaro/items/168667d5ee4c56b30d52

技術ブログをはじめよう Qrunch(クランチ)は、プログラマの技術アプトプットに特化したブログサービスです
駆け出しエンジニアからエキスパートまで全ての方々のアウトプットを歓迎しております!
or 外部アカウントで 登録 / ログイン する
クランチについてもっと詳しく

この記事が掲載されているブログ

プログラミング関連の気になったことをまとめて残しておく

よく一緒に読まれる記事

0件のコメント

ブログ開設 or ログイン してコメントを送ってみよう