前提条件
主語デカ釣りタイトル記事につき、最初に対象を限定しますが、差分とコメントが確認できるVCS(バージョン管理システム)を使っている開発環境を前提としています。
また、個人の検証コードなどで、他の人に見せないコードであれば好きにコメントアウトを活用すればよいと思います。
結論
処理のコメントアウトはせずに、その行は消して、消した理由をコミットコメントに記述せい。
この記事を書いた経緯
- 個人的には当たり前だと思っていたのですが、普通にかましてくるエンジニアをちょこちょこ観測しているため。
- もしかしたら、コメントアウトを書いた方がいいケースもあるかもしれないため、それについての意見が欲しいため。
- コメントアウトの是非について述べている記事をあまり見かけないため。
そもそもコメントアウトとは？
そもそもコメントアウトとは何か。
コメントアウトとは、処理をコメントによって、コンパイラないし、処理系に対し解釈させないようにして、その処理を無効化する事をさします。
#include <stdio.h>
int main()
{
// printf("Hello, World!");
printf("Hello! Hello!");
return 0;
}
結論の理由
- そもそも、コードの変更履歴管理はVCSの役割であって、コメントの役割ではない。
- シンタックスハイライトが効いてりゃいいが、効いてない環境で見た際にネストが深かったりするとコメントアウト行なのか処理行なのか判別しづらい。
- 処理を追ってくるときに無関係なコードが出てくるとうざくてかなわん。ましてや複数行など殺意が湧く。
- 本来の意味でのコメントと混ざる。
- エンジニアの手抜き以外のケースで使われているのを見たことがない。