コードレビュー

2026/9/8

AIが書いたコードをそのまま使っていい？提出前の確認チェックリスト

AIのコードで画面が動き、テストも通った。それでも、このまま仕事の成果物として提出してよいのか迷うことがあります。先に結論利用許可と、渡す情報を確認する。アカウント・用途・操作の範囲は、契約や設定と合わせる。仕様は、許可・拒否・失敗の場面で照合する。正常に動いたことだけで判断しない。確認済みと未確認を分けて採用を判断する。未確認がある相談用の成果は、その状態を明記する。架空の問い合わせ管理を使い、提出前の判断材料を整理します。特定製品の性能や契約条件を比べる記事ではありません。所属先の規程と、採 ...

設計・テスト・レビュー

2026/9/8

コードレビューで指摘されたらどう返す？修正・質問・見送りの例文

レビューで「ここは直した方がよさそうです」と届いた。直すべきか、理由を聞いてよいか、今回は対象外だと伝えてよいか。コードより返答に時間がかかることがあります。先に結論まず指摘の意図を確かめる。必須の修正か、改善提案か、質問かを揃える。修正・質問・見送りの相談を分ける。判断が残る点を「対応しました」で閉じない。変更箇所と確認結果、残る判断を返す。未確認は未確認として伝える。以下は、件名が必須・1〜100文字の問い合わせ管理を改修する架空の会話例です。実際のレビューや実行済みのテスト結果ではありませ ...

設計・テスト・レビュー

2026/9/8

プルリクエストの書き方｜初めてのPRで伝える変更理由・確認結果

PRの説明が「件名を追加しました」だけだと、レビューする人は差分から目的や確認状況を探すことになります。何を書けば、変更を判断してもらいやすいのでしょうか。先に結論目的・変更点・確認結果・未確認・見てほしい点の五つを揃える。「テストOK」は条件と結果に分ける。まだ試していないことは未確認と書く。説明と実際の差分を照合する。変更や追加確認をしたら、説明も更新する。以下は、問い合わせに必須・1〜100文字の件名を追加する架空例です。実在のPRや実行済みのテスト結果ではありません。差分から見えない「 ...

設計・テスト・レビュー

2026/10/15

プログラミングにおいてJavaDoc/コードコメントの効果的な書き方について

このページに書いてあることこのページでちょろっと書いた、「意味のないコメント」についてさらに啓蒙が必要だと思ったので追記します。対象はJavaDocとコードコメントの両方です。関連記事プログラミングのバグや無駄を減らすために意識してほしいこと4つ文字列比較・マジックナンバー・定数・コメントについて、バグや無駄を減らすための見直しポイントを確認できます。記事を読む → 自分もハッピー、以後メンテナンスする人もハッピーになるためにプログラムを書く人の助けになれば。ちなみにコードレビュアーからの目線と ...