効果的なコードレビュー：懐疑論者からの9つのヒント

私は理論を知っていました。 コードレビューは次のことに役立ちます。

• バグを見つける
• コードの読みやすさと保守性を確保する
• チーム全体にコードの知識を広める
• より速い新しいチームメンバー
• 問題を解決するための新しいアプローチを全員に示します。

または、それは単なる時間の無駄です。 少なくともそれがコードレビューの私の第一印象でした。



私は最近リリースされた新人で、ロンドンのソフトウェア会社のプラグインを開発していました。

しばらくして、同一または類似のコードのブロックを提供する必要がありました。 彼らは不幸な男に見られるべきだった（「彼は最高だ」と私のマネージャーは言った。ただ一つの善行ではない ...（ 罰せられない ））しかし、それぞれのレビューは何か新しいもので戻ってきた。プロセス。

さらに悪いことに、コード検査は数週間ではないにしても、数日間続いていました。 コードを受け取ったとき、どのように書いたのかほとんど覚えていませんでした。 これはその男のせいではなかった。 彼は上級レベルの開発者に尋ねましたが、私を手に入れました。 彼は経験の浅い開発者が犯した間違いにうんざりしており、コードレビューはこの不満を取り除く方法でした。

これに加えて、ブランチの同期、コンテキストの切り替えで失われた時間を...私はこれが好きではありませんでした。

数年先にジャンプして、私はジェフ・アトウッドのツイートに同意します。

「コードを改善するために、コードの共同レビューを行うことができます。」

過去数年間を評価すると、コード以外のレビューが悪いことを理解しています。 コードのレビューは不十分でした。 そして男、私たちはそれをひどくやった。

私は自分の肌でこれを学びました。 そして、もちろん、理解はすぐには来ません。 しばらくしてから、コードのレビューがアセンブリの変更を壊して厄介なものから私を救ったことに気付きました！ しかし、私は他の場所で働いた後、さまざまなより良い働き方の経験を積んだ。 これにより、以前は認識していなかったコードレビューの利点を直接確認する機会が与えられました。 したがって、今私は自分自身を修正された懐疑論者と考えています。

そのため、このような苦痛を避けることができます。ビデオをご覧になり、効果的なコードレビューに近づけるヒントをお読みください。

9レビューのヒント

皆のために：

• 最も重要なもののみを参照し、残りはツールに任せる
  
  書式設定とコードスタイルについて議論する必要はありません。 これらの問題を一貫して解決する多くのツールがあります。 コードが正しく、理解可能で、保守可能であることが重要です。 もちろん、スタイルとフォーマットはこれの一部ですが、ツールにこれらのことをテストさせる必要があります。
• 全員がコードを表示する必要があります。
  
  他の人よりも優れている人もいます。 より経験豊富な人は、より多くのエラーを発見する可能性が高く、これは重要です。 しかし、より重要なのは、一般的なコード検証に対する前向きな姿勢のサポートです。これにより、「私たちは彼らに反対している」という態度や、コードレビューにとって誰かにとって負担になるという事実を回避できます。
• すべてのコードを見る
  
  コードが短すぎたり、単純すぎたりすることはありません。 すべてを見れば、何も見逃せません。 さらに、これはレビューをプロセスの一部にし、習慣ではなく、要件にします。
• 前向きな姿勢をとる
  
  これは、レビュー担当者とコード作成者の両方にとって重要です。 コードレビューは、5つすべてを取得してコーディングスキルに影響を与えるときではありません。
  
  守備の位置を取る必要はありません。 建設的な批判の前向きな姿勢でレビューにアプローチすると、このプロセスに自信をつけることができます。

レビュアー向け：

• コードレビューは頻繁に短いセッションにする必要があります
  
  レビューの効果は約1時間後に低下します。 そのため、1つの大きなセッションですべてをレビューするレビューを延期しても、誰も助けにはなりません。 あなたの休憩に合った日中の時間を見つけてください-流れを妨げて習慣を形成しないようにしてください。 あなたの同僚はあなたに感謝します。 待つことはイライラする可能性があり、コードがまだ新鮮なうちに問題を迅速に解決できます。
• 「すべて順調」と言うのは正常です
  
  厳選しないでください。各レビューで問題を探す必要はありません。
• チェックリストを使用する
  
  チェックリストのチェックリストは一貫性を保証します-誰もが重要かつ一般的な間違いを追跡できるようにします。

コード作成者向け：

• コードは簡潔でなければなりません
  
  200行のコードの後、コードの効率は大幅に低下します。 400行を見るときには、ほとんど意味がありません。
• コンテキストを提供する
  
  関連するチケットまたは仕様へのリンクを提供します。 これに役立つKilnなどのコードレビューツールがあります。 コードに短いが、役に立つコミットと多くのコメントを与えます。 これはレビュアーに役立ち、質問が少なくなります。

Kiln Code Reviewのウェビナーに今すぐ登録する

次のオンラインウェビナーに参加してください。 初心者が当社製品のコード検査に関する基本を学ぶのに役立ちます。

以下について説明します。

• コードレビューとは
• コードレビューを使用する理由
• いつ使うか
• レビュー中に見るべきもの
• レビューを作成
• レビューのコメントとそれらへの回答
• 既存のレビューを操作する
• コードレビュープロセス

席に着くには、 今すぐ登録してください 。