ユアマイスター株式会社エンジニアブログ

ユアマイスター株式会社のエンジニアが日々徒然。

コードを日本語で読もう

こんにちは。エンジニアインターンの土屋です。
コードを日本語で読む大切さ。前回もそんな記事を少し書いた気がしますが、具体的にどう読んでいくのか。。
例えばこんなメソッドがあったとします。
条件は、

  • テストの質問に対する答えを紐づけて検索し取得する

  • 新しい質問が一番最初に来るように検索する

   public function findTestQuestionsHaveTestAnswers(Query $query, $option) {
  $query
    ->where(['product_id' => $option['productId']])
    //引数で指定されたproductIdとproduct_idが一致した場合
    ->andWhere(['id IN' => $option['TestquestionIdHasTestAnswer']])
    //かつ引数で指定されたTestquestionIdHasTestAnswerのいずれかがidと一致した時
    ->order(['registration_num' => 'desc', 'TestQuestions.created' => 'desc']);
    //昇順にregistration_numを並び替え、registration_numが被ってしまった場合TestQuestions.createdの昇順に並べる
    
    return $query;
}

コードが日本語で読めることの大切さ

  • 曖昧なコードを書かずにすみ、バグの原因にならない
  • 意味を理解しているため、他人に1行で何をしているのか明確に説明できる
  • みんなが理解できるコードになるため、読みづらいコードにならない

    私もまだまだコードを読むことができていません。
    ぜひ、エンジニア初心者の方やインターン生の方がいたら、声に出して読んでみてください!
    なかなか読めないし、日本語で表すのが難しいことを実感します。。。


    おまけ
    降順(DESC)と昇順(ASC) があり、降順は値が大きいものが一番最初。逆に「1、2、3….」と値が増えていくのが昇順です。
    ASCは同じ「あ」と言う発音始からまるUP(アップ)。なので、1、2、3…となる。って覚えるといいよ!! と、偉大なエンジニアの方に教えてもらいました!
    よく使うので覚えるときに便利です!

    以上、土屋でした。