ぷろみん

プログラミング的な内容を扱ってます

ソースコードのコメントよりも作業ログの方がコスパが良い

個人的にはソースコードのコメントに残すに堪えない情報こそが大事だったりすると思うので、ソースコードのコメントよりはissue等の別ドキュメントに作業ログを残すことが大事なように思われる。
例えばAしてもダメでBしても駄目だったからCしたらコード汚くなったけどなんかいけた。といった情報はソースコードのコメントには書きづらいが結構有益な情報になったりする。
ソースコードのコメントにURLを貼るのは賛否あるがソースコードと連携した作業メモが良さそうに思う。

Aの仕様とBの仕様の接続性悪くてビビる。

とかの愚痴みたいな10秒で書いたコメントも中々有益でコスパが良い。