プログラムコードにコメントを書かざるを得ない時は、具体性と抽象性のレベルを考えて、コードリーディングで伝わりやすい、だけど腐りにくい表現を選ぶ。

プログラムコードにコメントを書かざるを得ない時は、具体性と抽象性のレベルを考えて、コードリーディングで伝わりやすい、だけど腐りにくい表現を選ぶ。

  • コードにコメントを書かざるを得ない時、それがどれだけ腐りやすいかを考える。
  • 抽象度と具象度のレベルを考える。抽象的なほど伝わりにくいが、具体的なほど腐りやすい。
  • これならぎりぎり具体的に伝わりそうだし、実装変更によっても腐らなそうだな、という抽象度のコメントを選ぶ。

https://github.com/YumaInaura/YumaInaura/issues/527