サクサク読めて、アプリ限定の機能も多数!
トップへ戻る
デスク環境を整える
www.shuuji3.xyz
CL の作者がコードレビューを乗り切るためのガイド このセクションのページには、開発者がコードレビューを乗り切るためのベスト・プラクティスが含まれています。これらのガイドラインはレビューを素早く乗り切り、高品質な成果を生み出すための助けとなるはずです。すべてを熟読する必要はありませんが、Google のすべての開発者に利用されることが意図されており、全体を読み通すことで、多くの人が何か役に立つことを見つけられるはずです。 よい CL の説明を書く 小さな CL レビュアのコメントの扱い方 合わせてコードレビューの方法も読むことをおすすめします。コードレビュアのための詳しいガイドが説明されています。
コードレビューで何を期待するべきか 注意: 以下の各ポイントについて考えるときは、必ずコードレビューの基準を考慮するようにしてください。 設計 レビュー中に取り上げるべき最も重要なことは、CL の全体的な設計をどのようにするかということです。CL 中のさまざまなコードのインタラクションは意味のあるものですか? その変更はコードベースかライブラリ、どちらに帰属するべきものでしょうか? システムの残りの部分とよく統合されていますか? その機能を追加するのは本当に今が適切なタイミングですか? 機能性 その CL は開発者が意図した通りのことを行っているでしょうか? 開発者は、そのコードのユーザーにとって、どんなよいことがあると考えていますか? ここで言う「ユーザー」とは、通常エンドユーザー (もし変更がエンドユーザーに影響する場合) と開発者 (将来このコードを「使う」必要があるユーザーのこと)
コードレビューのコメントの書き方 まとめ やさしさを持ちましょう。 あなたの考えの論理を説明しましょう。 問題を指摘して明確な方向性を示すことと、開発者自身に決定させることのバランスを取りましょう。 レビュアのあなただけに複雑なコードの意味を説明させるのではなく、代わりに開発者に対して、コードをシンプルにしたりコードにコメントを追加してもらうようにしましょう。 礼儀 一般に、コードをレビューしている開発者に対しては、非常に明快な態度を取り、助けに満ちた気持ちを示すとともに、丁寧に、尊敬の気持ちを持って接することが大切です。このことを実践する方法の1つは、決して開発者についてコメントをしないで、必ずコードについてコメントをすることを忘れないことです。このプラクティスには必ず従わなければならないというわけではありませんが、このように話さなければ相手を怒らせてしまったり、争いのもとになってしまう
コードレビューの方法 このセクションの各ページでは、コードレビューを行う最善の方法について、長年の経験に基づいたおすすめを説明しています。ドキュメントすべては多数のセクションからなりますが、合わせて1つの完全なドキュメントを表しています。すべてを熟読する必要はありませんが、全体を読み通すことで、多くの人が何か役に立つことを見つけられるはずです。 コードレビューの基準 コードレビューで何を期待するべきか レビューで CL をナビゲートする コードレビューのスピード コードレビューのコメントの書き方 コードレビューでの反対の扱い方 合わせてCL の作者のためのガイドも読むことをおすすめします。CL のレビューを受けようとする開発者のための詳しいガイドが説明されています。
コードレビューの基準 コードレビューの主な目的は、Google のコードベースのコード全体の健全性が、時間の経過とともに改善されることを保証することです。コードレビューのツールとプロセスのすべては、この目的のために設計されています。 この目的を達成するには、一連のトレードオフの間でバランスを取る必要があります。 まずはじめに、開発者は自分たちのタスクを前に進めることができなければなりません。もしあなたがコードベースに対する改善を全く提出しなければ、コードベースが改善することは決してありません。また、レビュアがあらゆる変更を加えるのを非常に難しくしてしまえば、開発者が将来改善を加えようとするインセンティブが失われてしまいます。 一方で、各 CL が、時間が経過してもコードベースのコード全体の健全性が低下しないような高い品質を備えていることを保証することも、レビュアの義務です。しかし、それはや
コードレビュー 開発者ガイド はじめに コードレビューとは、コードの作者以外の誰かがそのコードを確認するプロセスです。 Google では、コードと製品の品質を確保するためにコードレビューを活用しています。 このドキュメントは、Google のコードレビューのプロセスとポリシーに関する正式な説明です。 このページは、コードレビューのプロセスの概要となっています。このガイドは、次の2つの大きなドキュメントからなります。 コードレビューの方法: コードレビュアのための詳しいガイドです。 CL の作者のためのガイド: コードレビュー対象の CL を作成する開発者のための詳しいガイドです。 コードレビュアは何を期待するべきか? コードレビュアは、以下の点について確認しなければなりません。 設計: コードはよく設計されており、あなたのシステムにとって適切なものですか? 機能: コードは作者が期待して
Google エンジニアリング・プラクティス ドキュメント このページは、Google Engineering Practices Documentation の非公式な日本語翻訳です。元のドキュメントは、クリエイティブ・コモンズの「CC-By 3.0」ライセンスで公開されています。 Google には、あらゆる言語・あらゆるプロジェクトをカバーする一般化されたエンジニアリング・プラクティスが数多く存在します。こうしたドキュメントは、私たちが長年に渡って開発してきたさまざまなベストプラクティスの経験が集結したものとなっています。オープンソース・プロジェクトやその他の組織でも、こうした知識から恩恵を受けられるかもしれません。そのため、私たちは可能な限り、この知識を公開するように努めています。 現在、以下のドキュメントが公開されています。 Google コードレビューガイドライン (Googl
このページを最初にブックマークしてみませんか?
『www.shuuji3.xyz』の新着エントリーを見る
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く