37:実装予定箇所にコメントを入れた時点でレビューしよう

プログラミング迷子: 自分の言葉で設計を説明しよう

  • 後輩W:レビューで指摘されたことを今読み返すと、ちゃんとわかってないまま実装進めちゃってました。次から、気をつけます。

  • 先輩T:それは今だからそう言えるけど、最初読んだときはわかったと思ったんだよね? だとししたら気をつけようがない気がするよ。

  • 後輩W:設計の意図を実装前にちゃんと把握するには、どうすればいいですかね?

  • 先輩T:コードを書き始める前に、設計を元に実装予定箇所にコメントでやることを書いていこう。で、それを先にレビューしましょう。

あとからなら間違っていたことに気づけても、それを事前に自分で気づくのは難しいものです。 また、自分が理解したことを文章で書いて依頼者に確認してもらうとしても、もともとの要件が文章になっている場合、それを改めて書き直してもあまり効果がありません。 自分で気づけないことであれば、先に自分の理解を実装コード上で表現してみましょう。

ベストプラクティス

ソースコードの実装予定箇所にTODOコメントを書きましょう。Pull Request(PR)でレビューしているチームであれば、その時点でPRを作ってレビューしてもらいましょう。 コメントには、実装の根拠になるチケット番号やドキュメントのURLを書きましょう。

cover

(中略)詳細は書籍 自走プログラマー をご参照ください