Developers-best-practices-write-to-be-reviewed
提供:Dev Guides
レビューを書く
ベストプラクティス4-レビューするコードを作成する必要があります
ソフトウェアコードを記述している間、誰かがコードをレビューすることになり、以下の点の1つ以上について批判を受ける必要があることに注意してください。
- 悪いコーディング
- 標準に従っていない
- パフォーマンスを考慮しない
- 履歴、インデント、コメントは適切ではありません。
- 可読性が悪い
- 開いているファイルは閉じられていません
- 割り当てられたメモリは解放されていません
- グローバル変数が多すぎます。
- ハードコーディングが多すぎる。
- 不十分なエラー処理。
- モジュール性はありません。
- 繰り返しコード。
コーディング中に上記のすべての点を念頭に置き、ソースコードにジャンプする前にそれらを停止します。 コーディングが完了したら、少なくとも1回はセルフレビューを行ってください。 自己評価は、90%の問題を自分で解決するのに役立つと確信しています。
コーディングとセルフレビューが完了したら、コードレビューを依頼してください。 レビューコメントを喜んで受け入れることを強くお勧めします。コメントについてコードレビュー担当者に感謝する必要があります。 同時に、他の誰かによって書かれたソースコードを批判することは決して良いことではありません。 一度も実行したことがない場合は、一度試して、コーダーの表現を確認してください。
批判を受け入れるが、批判しない
ソースコードの作成が不十分な場合、積極的にそれを理解し、そこから教訓を学べば、優れたソースコードを作成することができます。
あなたの目標は、最初にバグを止めて、バグのないコードを作成することです。 テスターのように考えて、テスターに挑戦してください。