初めに
自分は6月からサーバーサイドエンジニアとして働くことになりました。
エンジニアとしてプロジェクトに参画する前に、ただ動くコード
ではなく、良いコード
について学んでおきたいなと思ったので、以下の記事を参考に良いコードとは・・・についてまとめてみました!
良いコードとは・・・
大きく分けると、
1.プロジェクトのコーディング規約
2.フレームワークのコーディング規約
3.PSR-2(コーディングスタイルのガイド)
4.自分で決めたコーディングスタイル
5.関数や変数の命名
6.コードの共通化
コーディング規約
良いコードの一つとして挙げられるのがコードの可読性(読みやすいコードになっているか)。
コードの可読性を向上させるにはコーディングスタイルを統一する必要があり、プロジェクトごとに異なった複数のコーディング規約が定められている。
1.プロジェクトのコーディング規約
多人数が参画するプロジェクトでは予めコーディング規約が定められている場合がある。
予め規約が定められている場合は、その規約に従ってコーディングする。
2.フレームワークのコーディング規約
フレームワークにはコーディング規約が定められている。
フレームワークに定められた規約に反したコーディングをしてしまうと、面倒な設定をしなくてはいけなくなってしまう場合がある。
既存プロジェクトに予め規約が定められてない場合には、フレームワークに定められた規約に従うと良い。
3.PSR-2(コーディングスタイルのガイド)
PHPには、標準的なコーディングスタイルのガイドとして、PSR-2( https://www.php-fig.org/psr/psr-2/) がある。
4.自分で決めたコーディング規約
こだわりや理由があるときは、自分で決めたコーディング規約で行うのもあり。
変数や関数の命名
5.変数
変数名は何の値が代入されるのかを具体的に単数形の名詞
で表す。
その変数が配列であれば複数形の名称
にする。
5.関数
関数・メソッドは何かしらの処理を実行するので動詞
で表す。
基本的に何の処理を実行させたいのかわかるように命名してあげる。
(例)フルーツの値を取得する関数→getFruits()
コードの共通化
6.重複してるコードを共通化する
実行したい処理内容と意図が同じようなコードに関しては、共通のコードをまとめて共通化してあげることで、何か修正点があった時にまとめたコードのみ修正すれば良いためメンテナンス性や変更容易性を向上させることができる。