Переключаемые комментарии в коде

Кодить бывает сложно!

Иногда, разбираясь в чужом коде (php, actionscript, javascript и т.п.), я вижу очень неумелое и нерациональное использование комментариев. Сегодня я напомню вам об одной удобной фишке -- "переключаемых комментариях".

Итак, где будет удобно использовать "переключаемые комментарии"? Например в файле конфигурации.

Рассмотрим пример, когда часто меняется база данных в php-проекте (допустим, проект переносится с хостинга на локалхост и обратно).

Параметры подключения записаны в конф-файле:

$db_host = 'my.domain';
$db_base = 'mydb';
$db_user = 'root';
$db_pass = 'qwerty';

и их каждый раз приходится менять на другие:

$db_host = 'other.domain';
$db_base = 'yourdb';
$db_user = 'guest';
$db_pass = '123456';

Используя комментарий-переключатель, это удобно сделать так:

//*
$db_host = 'my.domain';
$db_base = 'mydb';
$db_user = 'root';
$db_pass = 'qwerty';
/*/
$db_host = 'other.domain';
$db_base = 'yourdb';
$db_user = 'guest';
$db_pass = '123456';
// */

В этом примере первый блок работает, а второй закомментирован. Но стоит только стереть первый слеш, как работать начинает второй блок, а первый становится комментарием.

Таким же образом можно включать/выключать целый блок кода, стирая/добавляя всего один символ (тот же первый слеш):

//*
echo 'Hello World!';
// */
/*
echo 'Hello World!';
// */

Стоит заметить, что эти способы работают не только в языках, упомянутых в начале заметки, но и во всех, где многострочные комментарии задаются с помощью /* и */, а однострочные -- с //.

Вот так вот!

Добавить комментарий