共同開発でコーディングする際のおやくそく

コーディング規約

エンジニアにとって、仕事をする上で大切なことのひとつに、コーディング規約があります。

コーディング規約（Coding conventions）は、ソフトウェア開発において一貫性のあるコードを書くためのルールやガイドラインのことです。

コーディング規約は、プログラムの可読性、保守性、品質を向上させるために重要です。

コーディング規約は、コードの書き方に関する様々な要素をカバーします。

例えば、インデントのスペースの数、行の長さの制限、変数や関数の命名規則、コメントのスタイル、制御構造の配置などです。

これらのルールは、ソフトウェア開発者がコードを統一的に書くことを促し、コードの読みやすさや保守性を高めます。

コーディング規約は、個々のプロジェクト、チーム、開発者コミュニティによって異なる場合があります。

コーディング規約を遵守することにより、コードの一貫性が保たれ、他の開発者との協業が容易になります。また、コードの可読性や保守性が向上し、エラーやバグの可能性を減らすことができます。

したがって、コーディング規約はプロジェクトの品質向上に貢献する重要な要素となります。

以下に、PSR-2の主なルールです。

インデント:
- インデントにはスペース4つを使用します。タブは使用しません。
行の長さ:
- 行の長さは最大で120文字までとします。
閉じ括弧:
- 閉じ括弧 } は、制御構造（if文、forループなど）やクラス、メソッドの定義の直後に配置します。
スペース:
- メソッド名や制御キーワード（if、for、foreachなど）の後にはスペースを1つ入れます。
- 演算子の前後にはスペースを1つ入れます。
名前空間:
- 名前空間は <?php タグの後、ファイルの先頭に記述します。
クラス・メソッド・プロパティの命名:
- クラス名はスタッドキャメルケース（UpperCamelCase）で命名します。
- メソッドとプロパティはカメルケース（camelCase）で命名します。
ファイルの終端:
- ファイルの最後には改行を入れます。

これらはPSR-2の一部ですが、Laravelにおける主なコーディング規約のポイントです。プロジェクトによってはさらに独自の規約があるかもしれませんので、プロジェクトチームやコミュニティの指針に従うことも重要です。

そのほかの記載のルールを載せておきますので必ず確認してください。

ネーミング規約

マジックナンバーについて解説しているのでとても重要なので確認してください。