あなたのチームでは、どのようなコーディング規約を採用していますか？

チームで開発を行う際に、コーディング規約を作成しようと考えていますが、どのようなコーディング規約が効果的なのか、参考になるチーム例を探しています。
あなたのチームでは、どのようなコーディング規約を採用しており、どのような効果があったのか、経験談を教えていただきたいです。
1年前
view数 79

    回答を投稿して企業にアピールしましょう！

    Q&Aで投稿された回答は、
    企業側に表示されるプロフィールにも投稿履歴として表示されます。

    Offersにログイン・新規登録して、気になるテーマやトピックを話してみよう！

    簡単1分登録(無料) ログインする

    ＼回答があります！／

    • 横江 亮佑

      エンジニア

      1年前

      どの言語やフレームワークを使っていらっしゃるか書いてくださると、
      みなさん、よりご回答しやすくなるかと思います！

      私のチームで言語共通であるのは、
      『コードをコメントアウトするときは、コメントアウトした理由をコメントする』
      というルールですね。

      これは、「削除でなくコメントアウトということはなにか意図があるのかな？」と判断に迷って
      その行を消せなくなることを防ぐためにあるルールです。

      // 2023/9/10 にこのコードを戻す予定なので一時的にコメントアウトしてある
// showPopup();


      例えばこのように、削除でなくコメントアウトにした理由を書くように求めています。

      あとはだいたいの言語には Linter があるはずなので、
      それによる指摘を GitHub Actions で https://github.com/reviewdog/reviewdog を介して
      プルリクエストに自動でコメントしてあげるようにすると、レビュアーの負担が軽くなるかと思います！
      view数 12