テキストリンク引数の極意メソッド名、引数をみて何をやっているか分からないメソッドはストレス値が上がりますよね。分かりやすい引数について考えて書いてみました。このメソッドの引数を極意に合わせて修正して行きます。お店の住所、商品の値段、商品カラー、1ページの表示数とします。引数をもとにデータを絞り込み取得したデータを返却するメソッドをイメージしてください。メソッド名は簡略化のため適当です。曖昧さを減らし明確な名前をつけるべし引数を定義する上で大切なのは、メソッドを使う人がどこに何を送ればいいか迷子にならないことです。Docとかに書くのもいいですが、まずは変数名を明確にしましょう!以下のよう、曖昧さを減らし明確にしましょう。$itemName今回は、google翻訳ですぐ出るような名前にしましたが、チームで共通認識になっている言葉を使うのが一番いいかなと思います!僕がいるチームでは商品はproductsテーブルにあるので、商品に関する変数名は$product〇〇で共通化しています。型を宣言すべし物によっては文字列じゃなくて、数値でデータを管理しているパターンもあるでしょう。今回は、$colorが文字列ではなく数値でデータを管理しているとします。緑こうした時に業務上の知識を細かく把握してる人じゃないと、$colorに文字列を送るのか数値を送るのか、判断が難しくなってしまいます。小さな不明確事項はストレスの原因です。それを防ぐために、引数に型の定義をしてあげます。$perPage)これでどういう値を送ればいいかさらに明確になりましたね!DDDなど利用してる場合は、値オブジェクトで型を宣言するとさらに良くなると思います。意味でまとめるべし業務知識がある人が見るとわかるのですが、今の引数の状態だとどの引数が検索条件なのかがちょっと曖昧です。うまくグループ分けをしてどれが検索条件かわかるようにしましょう。私の理想パターンだとDTOなど検索用パラメータを保持できるオブジェクトを作成して引数にするパターンです。$perPage)}LIKE検索するのであれば変数名にlikeをつける、大小の比較を実施するならgtやltをつけるなどプライベート変数名を工夫するともっと分かりやすくなるかなと思います。DTOなんてうちのチームでは導入できないよー。いう場合はまとめずにLevel.2の状態のままが良いかなと思います。$perPage)配列にしてしまうと検索できる条件が不明確になるのであまり良くないかなと。検索条件がかなり増えて引数が7つ以上になるとかの場合は、配列にした方がコードが読みやすいかなと思います。あとがき的な引数の極意といいいつつ、分かりやすい変数名つけた方がいいよの話になってしまいましたね。次も極意シリーズとして描けるようにがんばります。https://zenn.dev/mayos/articles/9f34829390181c著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。protocolMoment.jsは非推奨だが安易にdate-fnsに変えるな。Sitemap🍪このウェブサイトは、あなたが我々のウェブサイトで最高の経験を得ることを確実とするために、クッキーを使います。