コードレビューを文書化する必要がありますか？

Question

私はこれについて考えたことは一度もありませんが、問題の内容、変更するファイルなどのログを保持することを文書化することによって、コードレビューを文書化しているように見える人もいます。 個人的には、アイデアはそれがそれほど動的ではなく、私はそれが不適切に使用される恐れがあるので、そこには何の意見がありますか？

Answer 1

コードレビューは、2つの主な目的役立つ：

コーダの品質を向上させるために最初のドキュメントから利益を得ることができるコード

の品質を向上させる

• を：

  "機能Aは、Zを使用する方が良い場合にXとYを使用することが多いことに気づきました。

  第二は、一般的にはできません。

Answer 2

もちろんです。

あなたがそれから学びたい（そして他の人が学ぶことを可能にしない）場合を除き、

Answer 3

私は投票しません。主にそれは指のポインタを除いて何の利益ももたらさないからです。

Answer 4

はい、コードレビューの期待とアプローチを文書化する必要があります。それは多くのドキュメンテーションである必要はありませんが、少なくともいくつかは後であなたを助けるでしょう。

Answer 5

レビューによりますと思います。

あなたが「正式な」レビューをしていて、多くのファイル（または多くのコード行）を見直しているのであれば、必ず言及しておきたいことは、レビュー。

小さくてシンプルなコードをレビューしている場合は、紙面にいくつかの発言をぶつけたり、レビューアにその発言を記入したりするだけで何も問題はありません。

Answer 6

出席者が一般に同意した変更が行われることを一般に信じている場合は、大したことではなく、最初に各問題の合意に同意する傾向があります。

軽いアプローチは、それぞれのケースを「気づいた」（通知されたものの、作成者からの行動は期待されていない）、「変更される」などとマークすることができます。これは、すべての出席者が、単一のインシデントで実際に行われることについて、同期していることを意味します。

ドキュメンテーションが多すぎると、コードの見直しが面倒でバカラになります。どの方法が最良かは、プロジェクトの種類（銀行/宇宙とそれほど重大ではないもの）と、同じ企業で働くのか、それとも下請けのレビューであるのか（= /通過するとき）。

Answer 7

巨大なプロジェクトでは、レビューを文書化する必要があります。場合によっては、変更を古いコードに戻す必要があるかもしれません。新しいコードにバグがあり、元のコードに戻す必要があるかもしれません。常に文書化する方が良いです。私はそれが不適切に使用される可能性があるというあなたの主張を買わない。それを不適切に使用しようとする人は、それを達成するための他の多くの方法を持っています。

Answer 8

私にとって、コードレビューを文書化する目的は、todoリストに同意することだけです。これは、問題追跡データベースにこのToDoリストの項目を入れることによって形式化されてもよい。

Answer 9

コードレビューは、文書化されなければならない「トムは再びめちゃくちゃ」。多くの人が選択的な記憶を持っており、特に書き換えようとするよりも埋め込みが容易なときに便利な形でいくつかのフィードバックを忘れるでしょう。

Answer 10

コードレビューの作成、文書化、追跡に役立つ多数のコードレビューツールがあります。レビューアノテーションを読んでいるjavadocドックレットやSCMでチェックインできるレビューコメント付きのテキストファイルを作成するのと同じくらいシンプルにすることができます。より複雑なソリューションをデータベースでバックアップし、レビュー方法のワークフローを構成することさえできます。

すべては、プロジェクトの規模（チームサイズ、コードベース、変更リストなど）によって異なります。プロジェクトが大きくなればなるほど、良いコードレビューが必要になります。

Answer 11

いくつかの理由でコードレビューの結果を文書化する必要があります。このセクションの他の投稿は、フィードバックを文書化して忘れられないように（または意図的に無視される）、作成者の参照のために「行うべきこと」のリストが保持されるようにすることの利点に焦点を当てています。私は同意するが、同僚のレビューのコスト（主に工数がかかる）と有効性（通常は数量とタイプ/欠陥のカテゴリ）に関するデータを収集することが同様に重要であると考える。ほとんどの人が知っているように、ピアレビューの有効性は業界のデータと相互参照して、欠陥を除去するコストを知ることができます。プロジェクトの予算とスケジュールを担当する担当者は、この情報を使用してピアレビューに適切な時間とリソースを割り当て、その割り当てを経営陣、顧客、またはその他のステークホルダーに守る。

また、ピアレビューの結果を指差しとして分類できる場合は、ピアレビューを最も確実に実行していません。あなたの店でこれが起こっている場合は、あなたが解決策の一部になる可能性があることをご存じですか。あなたのお店がお互いの仕事の製品を査読するのではなく、仲間を見直すことであなたのお店が無駄になっている時間を回復させるのに役立つ無料の情報源がウェブ上にあります。