コードの判断を説明するコメントの書き方。
コメントは意図や自明でない制約を説明するものです。単純なコードを文章で繰り返すだけでは雑音になります。
作業手順をタスクに合わせましょう。
コードの背後にある自明でない理由、不変条件、制約を特定し、関連処理の近くで説明します。単純な構文を読み上げるだけのコメントは削除し、説明を実際の動作に合わせてください。
- 用意するもの
- コードとプロジェクトの文書スタイル。
- 得られるもの
- 意図と制約を説明する有用なコメント。
入力と結果を確認しましょう。
説明用の入力と出力 · 実際の WebAct 実行ではない学習用サンプル
入力項目サンプル個
Add an intent comment to this JavaScript mapping. Original row IDs must remain available so reviewers can trace comparison results to their sources.
const copied = rows.map(row => ({ ...row }));完成例
// Retain source row IDs so reviewers can trace each comparison finding.
const copied = rows.map(row => ({ ...row }));
The comment explains why the IDs remain. The code still makes shallow copies; nested objects are shared.この入力をプロンプトに読み込み、WebAct にコピーして試してください。結果は掲載例と異なる場合があります。
判断のポイントとトラブル対処。
すべての代入にコメントを付けるべきですか？
意図や制約が不明になる箇所に付けます。コードを文章で繰り返すと、判断を説明せずに保守作業を増やします。
役立つコメントがリファクタリング後に誤解を招くのはなぜですか？
変わった動作と併せて見直し、古い前提を更新または削除してください。コメントも保守する説明の一部です。
自分の資料で試しましょう。
タスクのプロンプト内の例を自分の資料に置き換えてください。必要な要件を残し、タスクを WebAct にコピーします。
タスクを調整してコピー ↑