こんにちは、エンジニアの神山です。
今回は私がコードを書く際に意識している内容を書きます

変数、関数名の名前

基本中の基本かと思いますが、1番重要かなと思います。

$dataArray = ['apple', 'orange'];

上記だと配列だとわかりますが、コードが少し長くなると何の配列なのかがわからなくなったりします。
※稀に見ます

$fruitsArray = ['apple', 'orange'];

上記のように何の配列かを記際すれば、コードが長くなっても混乱することはないと思います。
また、変数名をキャメルケース、アッパーキャメルケースなのか迷った際は、フレームワークのソースコードを読んで、同じように合わせるようにしております。
英語がわからい場合は、DeepL様様に頼っています・・・

if文の条件式

if文を書く際には「肯定」から書くようにしています。
理由としては、否定から入るとどうしても一瞬考えてしまうので、パッと読んだ時にすんなり理解しやすくするためです。

また、複数条件があるときは1つに書かずにネストさせたりします。
※ネストも2階層ぐらいまでに抑えます

if ($userName !== 'hoge') {
	// $userNameが「hoge」ではない場合
} else {
 // $userNameが「hoge」の場合
}

上記よりも下記のほうが読みやすいかなと思っております。

if ($userName === 'hoge') {
	// $userNameが「hoge」の場合
} else {
// $userNameが「hoge」ではない場合
}

三項演算子は基本的には書かないようにしています。
便利なのですが、後で読んだ時に少し考えてしまうのと、条件が長くなれば読みにくくなるためです。

早期return

関数やメソッドの処理では、処理が終わったらすぐに返すようにしております

public function getHogeHogeDay($month)
{
	$retDay = '';

	if ($month > 6) {
		$redDay = 10;
	} else {

			$redDay = 25;
	}

  return $redDay;
}

以下のように早めに処理を終わらせるようにしています。

public function getHogeHogeDay($month)
{
	$defaultDay = 25;

	if ($month > 6) {
		return 10;
	}

  return $defaultDay;
}

変数や関数の返却値の型

PHPですと型を意識せずにコードを書けるのですが、かなり意識して書くようにしています。
PHP自体も型指定の記述ができるようになったりしていますので、型は意識したほうが良いと思っております。

まとめ

基本的にはリーダブルコードに沿って意識するようにしています。
リーダブルコードを全て実践するのは難しいので、基本的な内容は抑えて、それを実践で利用するを繰り返しています。

最近はフレームワークやライブラリのコードを読むようにして、OSSのコードの書き方を真似たりしています。

書いた後にこうした方が良かったなーと思うことも多々あるので、精進していきます

 

＼弊社では一緒に働いてくれる仲間を募集しております／

エントリーはこちらから▼