РАЗДЕЛЫ, КОММЕНТАРИИ, ШАБЛОНЫ ОПИСАНИЯ PHP

ЛАЙВХАК 1

Способ как разделить код в php на разделы, и что бы эти разделы можно было удобно складывать-сжимать в текстовом редакторе. Если на странице кода очень много, что бы постоянно не прокручивать те разделы, которые в данный момент не нужны можно их сжать и работать с минимумом лишнего кода.

// ( ============================================= РАЗДЕЛ 1 =============================================
echo 'Тут код php';
// ) ============================================ END РАЗДЕЛ 1 ==========================================

либо с фигурной скобочкой

// { ============================================= РАЗДЕЛ 2 =============================================
echo 'Тут код php';
// } ============================================ END РАЗДЕЛ 2 ==========================================

Как это решение работает в разных редакторах:

• в Ispmanager'oвском редакторе: работают оба способа
• в Visual Studio Code: работает только с фигурной скобочкой
• в Notepad++ не работают оба способа

Для закомментированных участков - описание, документация, подойдет другой способ:

/* ===========================================================================================================================================
echo 'тут закомментированный код';
=========================================================================================================================================== */

ШАБЛОН ДЛЯ ФУНКЦИИ С ОПИСАНИЕМ

/* ================================ test_function ================================================================================= 
{

Функция выводит имя переменной и имя константы через нижнее подчеркивание
Для работы функции необходимы:
-константы: CONST_NAME
-переменные: $name

================================================================================================================================= */

function test_function($name)
{
  if($name)
  {
      return $name.'_'.CONST_NAME;
  }
  else
  {
      return false;
  }
}

// } ========================== end test_function =================================================================================

Дополнительный плюс этого метода, что если функция находится в нескольких папках, сайтах и т.п., разных хостингах, по какой-то причине, а не require, то легко можно написать скрипт, который будет находить строки, содержащие = test_function =, = end test_function = и менять автоматически функцию и описание на её новую версию, т.е. то что находится между этими строками.

ЛАЙВХАК 2

Если работа идет с файлами, которые раскиданы по разным папкам, повсюду на хостинге или сервере, то для того что бы постоянно не мотаться туда-сюда можно сделать симлинки и тогда можно будет работать со всеми файлами из одной папки. А после завершения работы их можно удалить.

---