Laravelのソースレビュー時に多く指摘を出すことになる関数の宣言まわりのレビューポイントをまとめました。
ポイントに気をつけながら制作してもらえると、ソースコードを書いた本人でなくても、どういう関数なのかがスムーズに伝わると思います。
目次
関数のレビューポイント
- 関数名が処理に対して明確かどうか
- 関数名に対して、余計な処理をしていないか
- 例えば
getUserNameという関数名なのに、データを保存しているなど
- 例えば
- 関数名に対して、余計な処理をしていないか
- 関数名が動詞で始まっているか
- 引数の型は PHPDoc とそろっているか
- 戻り値の型は PHPDoc とそろっているか
ソースサンプル
レビューポイントを守っていない例
/**
* userNameGet
*/
public function userNameGet($user_id)
{
$user = self::find($user_id);
$user->last_login_at = date('Y-m-d');
$user->save();
return (empty($user) ? '' : $user->name);
}指摘無しの例
/**
* getUserName
* ユーザーの名前を取得する
*
* @param int $user_id
* @return string
*/
public function getUserName(int $user_id) : string
{
$user = self::find($user_id);
return (empty($user) ? '' : $user->name);
}