プログラミングしていると、ある部分を書き換える、でもその前のソースを残しておきたいということはよくあります。
不具合を検証している時とか仕様の変更があった時なんかによくありますよね！
その場はコメントアウトしておいて何か問題が起きたら元に戻すってとても便利なんですけど、改修が正常に動作したあと、そのコメントアウトした部分をどうするか、ちょっと迷うことがあります。
基本的には無意味なソースは消してしまった方がいいのですが、開発が終わるまでは残しておきたい気持ちもあります。
そんな時は、コメントを書いて残しておきましょう、そして最後の確認時の検索のために、あるワードを書き込んで置いた方が良いです。
例えば
「_DEBUG」
「_TEMP」
などなど
自分が書いたことがしっかり検索できるようにしておくのです。
「DEBUG」だけだと他のコメントにありそうでなので、わざと「_DEBUG」にしてあります。
そして基本的には製作が終わった段階ですべて削除しておくのがベストです。
どうしても残しておきたい場合、なぜ修正したのか、なぜ残しておくかも明確にコメントとして記載しておきましょう。
また、ある関数で多くの修正をする場合は、関数ごと書き直しましょう、元の関数名を「_FuncProcess」のように変えて新たに元の関数名で書き直した方が読みやすいですよね。
こちらの関数も最後にちゃんと削除しておきましょう。
なんにもコメントが無いコメントアウトされたソースって無駄に疑惑を生んでしまうのです。
________________________________
※フリーランスエンジニア、個人ビジネス、プログラム関連の個人コンサルをしています。
詳細は↓のリンクから
※私のYoutubeでは、プログラマ、フリーランスを目指している方に情報を発信しています。是非チェックしてみてください。
