私はさまざまな PHP スクリプトを使用していくつかの作業を行ってきましたが、簡単な質問がありました。それらのかなりの数には、次のようなコメントアウトされた行があります。
/*
$a = 1; $b = 2; $x = 1;
$y = $a * $x + $b;
if ( $y < 5 )
*/
コメントアウトされている場合、これらの行を削除しても安全ですか? コメントアウトされたばかりのファイルにコードを含める意味は何ですか?
私はさまざまな PHP スクリプトを使用していくつかの作業を行ってきましたが、簡単な質問がありました。それらのかなりの数には、次のようなコメントアウトされた行があります。
/*
$a = 1; $b = 2; $x = 1;
$y = $a * $x + $b;
if ( $y < 5 )
*/
コメントアウトされている場合、これらの行を削除しても安全ですか? コメントアウトされたばかりのファイルにコードを含める意味は何ですか?
コメントアウトされたばかりのファイルにコードを含める意味は何ですか?
何もない。一部の開発者は、古いコードのバックログのためにこれを行っています。代わりにソース管理 (SVN や GIT など) を使用する必要があるため、これは悪い習慣です。すべての履歴が、コメント アウト/置換された理由を示すコミット メッセージと共にそこに表示されます。
これらは削除しても安全ですが、単に削除するのではなく、コメントアウトした理由を開発者に尋ねてください。
はい、これらの行は安全に削除できます。ただし、コードがまだ関連していないことに注意する必要があります。別の開発者が何らかの理由でそこに残した可能性があります。
コメントは、コードのセクションを完全に削除せずに「無効にする」ツールとしてよく使用されるため、後でコードが必要になった場合は、コメントを解除して元に戻すことができます。
ただし、コメント付きのコードを長期的に残すのは悪い習慣です (これがバージョン管理の目的です)。
前の作成者は、コードでいくつかのテストを実行し、その後のテストのためにコメントアウトした可能性があります。理由はいくらでもあります。
はい、気になる場合はコメントを削除しても問題ありません。
ラインを安全に除去できるかどうかを本当に知っているのはあなただけです。
基本的に、はい - アプリケーションが意図したとおりに動作する場合は、必ずそれらを削除してください。
上記のようなコメント ブロックを削除しても、コードの出力には影響しません。
後で参照したい場合、コードを削除するのではなく、コメントアウトすることがよくあります。より良いオプションは、ソース管理を使用することです。その後、以前のコードを振り返って、削除された理由と時期を確認できます。
これらを削除すると安全です。バージョン管理システムを使用している場合、実際にはそのようなコメントは役に立ちません。この種のコメントは通常、人々がバージョン管理システムを使用しておらず、コードをコメントアウトして何かを試し、念のために古いコードを保持したい場合に発生します。バージョン管理システムを使用している場合は、いつでも古いバージョンのコードを元に戻すことができるため、これらのコメントは必ず削除してください。バージョン管理システムを使用していない場合は、使用する必要があります。
コードがコメントされた理由がわかるまで、触れないでください。このコードを開発した開発者に尋ねるか、コードを調べて、それらの行が必要かどうかを最初に理解してください。