コメントアウトについて

プログラマーの中にはコメントを拒絶する人がいる。
私もかつてそうであった。

ではなぜコメントを書く事を嫌うのだろうか？
その答えは、処理に必須でないもの記述することはプログラマーの美学に反するからである。

同じ処理ならファイルの行数は少ない方がいいに決まっている。

では、なぜそんな私がコメントを書くようになったのか？？

当時、私の所属していた部署ではコメントは書かない方が良いという文化が浸透していた。
新人であった私は当然それを鵜呑みにし、コメントを一切書かないコードを量産した。

数年後のある日、新人時代に書いたコードを改修する機会がやってきたのだ。

私は自分が書いたコードなのに最早それが自分の書いたものかさえわからなかった。

自分が書いたコードなら未だしも、人が書いたコードを読むというのは韓国人が書いた中国語を読むようなものだ。

人の入れ替わりが激しいIT業界では自分が書いたコードより、人が書いたコードに手を加えることの方が圧倒的に多いのだ。

ではどれくらいの量のコメントを入れればいいのか？

これは完全に人の好みと言うしかない。

参考までに私の記述例を紹介する。

定時バックアップ用のバッチファイルの例

rem --------------------------------------------------
rem 【説明】「Sample.dmp」を「d:¥backup」にバックアップします。
rem 【使用方法】このバッチファイルをタスクスケジューラに登録してください。
rem 【作成者】R.Kazashi
rem 【更新】2019/07/24 新規作成　R.Kazashi
rem --------------------------------------------------

@echo off
cd /d %~dp0

rem --------------------------------------------------

rem -コピー処理------------------------------------------
copy d:¥DMP¥Sample.dmp d:¥backup
rem --------------------------------------------------

処理に関してはどこで区切りなのかが分かるようにremを上手く活用しよう。
コメントの書き方なんて自分ルールを決めてしまえばいいのだ。