ソフトウェア開発者の日常

こだわりなく書きたいことを書いていきます。

ソースコードに限らずコメントはなるべく残す

スポンサーリンク

将来の自分のためにコメント残してます。

f:id:AJYA:20150528054053j:plain
photo credit: api_feed_item_enclosure via photopin (license)

以下の記事で、文章を書く際にコメントを書いておく方法を書かれています。cyblog.jp

僕の場合、記事冒頭にあるプログラムのソースコードにコメントを書くことはあたり前になっています。
記事にもありますが、

※この場合の「他の人」は、一ヶ月後の自分も含まれています。

という観点で書くようにしています。

ソースコード以外にも、見積や工数積算等でコメントは残すようにしています。
どのように考えてありそうな項目がない理由や、項目に対するその数字はどうやって導いたのか等、いろいろ思考の過程を残すようにしています。

そうしておくことで、再度利用することになった時になぜこうなったんだろ?と悩むことを防ごうとしています。