開発をスムーズに進めるためには命名規則に従って、名前を付けることも大事です。
他のフレームワークに比べると、Laravelの命名規則は厳しくないといわれていますが、いくつか作法があるのも事実です。
これからLaravelを始める人にとってはここを理解しておくと、全体に統一感が出て良いと思います。
目次
複数の単語を組み合わせる場合
プログラミングでは、複数キーワードの名前の付け方として記述方法が3つあります。
・アッパーキャメル記法
・ローワーキャメル記法
・スネーク記法
順を追って説明していきます。
アッパーキャメル記法
先頭を大文字で書き始め、要素の先頭を大文字にし、複合語のスペースをなくします。(パスカルケースとも呼びます。)
ローワーキャメル記法
先頭を小文字で書き始め、要素の先頭を大文字にし、複合語のスペースをなくします。
スネーク記法
単語と単語の間にアンダーバーを使用します。
文字のラインがくねくねした蛇に見えることがスネーク記法の語源です。
命名で気を付けること
次は命名で気を付けることを解説します。
一般的な名付け方
なぜ「一般的」と記載したかというと、名付け方は人によって異なります。好みについて議論しても一致点が見つからないからです。
長い名前は控える
名前は最大でも20文字程度までに控えるようにしましょう。名前が長いと可読性が落ちたり、入力が面倒で打ち間違いを引き起こすことがあります。
1 2 |
悪い例 $adoministrator_reset_password_code 良い例 $resetAdminPassCode |
理解できる名前にする
ただ、短過ぎればよいというものではありません。
キチンと意味の通じる名前にしましょう。
1 2 |
悪い例 $d 良い例 $desk |
命名規則のまとめ
命名規則は複数人で開発しているととても重要になってきます。
もし、自分の命名に自信がない場合は、サイトを使用して命名してみてはいかがでしょうか?
https://codic.jp/
私もたまに使用します。