/note/tech

コードレビューでよくお願いする、コメントの追加のパターン7選

• コードレビューでよくお願いする、コメントの追加のパターン7選

MEMO:

• (1) 変数やパラメーターの説明を書く
• (2) 複雑な処理や関数の説明を書く
• (3) 一見してなぜその処理が入ってるかわからない場合は補足する
• (4) 利用時の注意事項を書く
• (5) マジック変数の値の説明を書く
• (6) 公式ドキュメントやリファレンス、議論へのリンクを貼る
• (7) オプショナルな引数を渡す場合は、なぜ渡しているかを書く

(2024/11/20)