思考（試行）のキャッシュとしてのコメント
考えたらわかること、コードの他の箇所を読んだら/実行したらわかることでもコメントに書くと良さそう これつらい
こう書いたほうが良さそうなのになんでこんな書き方してるんや？→書き直したれ→あ〜これやとあかんのか→ほなしゃーないなぁ
このパラメータどういう意味？ →他のファイルやドキュメントを参照する
これどういう挙動するんだっけ？ →実行して確認
それ、コメントに書こう
1回コメントを書いたら確認を省略できる
ちょうどキャッシュのように
キャッシュ同様、情報が古くなってないかどうかに気をつける必要がある
なのでコメントを書きすぎてもつらい
git blame とかgit lensとかで古いコメントは注意して読むとか？
慣習的に /** から始まるブロックコメントを書いたらその下に定義した識別子をエディタからホバーで見れたりするので、うまく使う
参照側から楽に閲覧できるという性質から、外部仕様はブロックコメントに、内部使用はインラインコメントに書くと良さそう
関連ポスト