Переменные

Составьте описание каждой переменной.

Чтобы не запутаться в множестве переменных, каждая переменная должна быть осмысленной. Запишите в начале скрипта, а лучше в отдельном файле назначение каждой переменной, или для группы переменных, если они однотипные или относятся к отдельному модулю программы. Для массива укажите размерность и тип содержимого колонок, как если бы это были названия колонок в ListView. В последствии для обновления скрипта требуется заново угадывать назначение переменных, и иногда возникает предположение, что в некоторой переменной нет смысла, но если бы её назначение было описано заранее, то вопросов бы не возникло и при обновлении алгоритма можно было бы легко расстаться с некоторыми из них, не нарушая логику скрипта. Со временем можно забыть даже логику скрипта, и даже интуиция и знание своего стиля не поможет, так как стиль тоже модернизируется, поэтому внешний файл описания логики и назначения переменных поможет быстрее разобраться. Переменные должны быть описаны так, как если бы открыто окно настройки программы и каждый чекбокс назван доступным для понимания языком, не требующим угадывания.

Лишние переменные

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

Проблемы области видимости

Чтобы навсегда забыть проблему области видимости переменной, добавьте префикс к переменной, например $g_var, тогда можно избавиться от необходимости проверять объявлена ли эта переменная в глобальной области. Соответственно требуется всего лишь проверить уникальность переменной для текущей функции, так как другие функции эту переменную не видят.

Неочевидные сокращения

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

Слишком длинные переменные

Не используйте слишком длинные переменные, они не помогают восприятию конструкции. Строки сливаются с логическими знаками и требуется больше времени, чтобы понять. Я до сих пор твёрдо уверен, что переменная индекса массива должна состоять из одной буквы, например $i. Это счётчик, не представляющий уникальности, а вся уникальность должна заключаться в имени массива. Аналогично и счётчик цикла For. Если используется короткая функция на 5-10 строк, содержащая 3 переменных, то каждую из них также можно назвать одной буквой, например $a, $i, $d, это будет очень легко читаться.

Имена переменных

Попробую указать некоторые устоявшиеся у меня имена переменных:
$sPath - путь к файлу/папке
$sFileName - имя файла
$hFile - дескриптор открытого файла

$hGUI, $hForm - дескриптор окна
$iBtnOK - кнопка ОК, вторая часть имени - назначение кнопки
$iStatusBar - строка состояния
$iBtn - префикс кнопки
$iLb - префикс лейбла
$iCh - префикс чекбокса
$iInp - префикс поля ввода
$iEdit - префикс окна редактирования
$iCombo - префикс раскрывающегося списка
$iLV - префикс ListView
$iTV - префикс TreeView
$TrgName - триггер, вторая часть имени - назначение триггера

$sText - текстовые данные прочитанные из файла, или строка, слово
$iPos - поизция, например символа в строке
$aLng - массив содержащий тексты многоязычной поддержки программы.
$error - если требуется сохранить @error для последующего использования
$extended - если требуется сохранить @extended для последующего использования

$iCount - счётчик, сумма
$sDropped - брошенный в окно файл(ы)
$sAdded - добавленный
$iNum - число

$i - счётчик цикла For
$j - счётчик вложенного цикла For, хотя похожесть иногда пугает
$d - иногда счётчик итераций, например в While, хотя и в For, как параллельный независимый счётчик
$n - иногда счётчик итераций

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