レビューのために書く

ベストプラクティス4-レビューするためにコードを作成する必要があります

ソフトウェアコードを作成するときは、誰かがコードをレビューすることになり、次の1つ以上の点について批判を受ける必要があることに注意してください。ただし、これらに限定されません。

悪いコーディング
標準に従わない
パフォーマンスを考慮しない
履歴、インデント、コメントは適切ではありません。
読みやすさが悪い
開いているファイルは閉じられません
割り当てられたメモリは解放されていません
グローバル変数が多すぎます。
ハードコーディングが多すぎます。
不十分なエラー処理。
モジュール性はありません。
繰り返されるコード。

コーディング中は上記のすべての点に留意し、ソースコードにジャンプする前にそれらを停止してください。コーディングが完了したら、少なくとも1回はセルフレビューを行ってください。セルフレビューは、90％の問題を自分で取り除くのに役立つと確信しています。

コーディングとセルフレビューが完全に完了したら、コードレビューを同僚に依頼します。レビューコメントを喜んで受け入れることを強くお勧めします。コメントについては、コードレビュー担当者に感謝する必要があります。同時に、他の誰かが書いたソースコードを批判するのは決して良いことではありません。一度も行ったことがない場合は、一度試して、コーダーの式を確認してください。

批判を受け入れるが批判しない

不十分に書かれたソースコードは、あなたがそれを前向きに受け止め、それから教訓を学ぶならば、良いソースコードを書くことをあなたに教えます。

あなたの目標は、最初にバグを止めて、バグのないコードを作成することです。テスターのように考えてください。そうすれば、テスターに挑戦する必要があります。