Правила именования переменных

01.12.2015 переменные

 

Имя переменной это одно из наиболее важных элементов программирования, потому что по имени можно понять что за переменная и для чего она создана. Согласитесь что если создать переменную с именем $ee никто не поймет что она делает и для чего она нужна пока не прочитает полностью код.

Для большей конкретики определим определенные префиксы которые будут характеризовать переменную или свойство класса по ее типу:

a — префикс переменной массива.
s — префикс строки
i — префикс целого числа
d — префикс числа с точкой
is — переменная которая хранит true или false
_ — префикс свойства класса private или protected
В процессе разработки я сталкивался с такой проблемой что начинают пересекаться поля таблицы в базе данных, ключи элементов массива со свойствами класса или переменными. Например элемент массива стал переменной. Это проблема решается следующим образом все переменные и все ключи элемента массива а так же поля таблиц и таблицы в базе данных пишутся CamelCase — ом. Это позволит полностью избавиться от разношерстности когда.

В процессе разработки первым делом вы всегда проектируете какой то кусок программы при этом вы четко должны представлять что должно получиться в результате, какие методы того или иного класса должны использоваться. Какие параметры передаются, что должен возвращать тот или иной метод и выбрасывает ли он какие либо исключения. А в связи с этим вам просто необходимо писать комментарии к каждому методу, свойству и любому программному блоку. Возможно вам это в последствии позволит быстрее разобраться в написанном вами куске кода. Важно помнить несколько правил при написании комментария:

Комментарий должен быть на английском языке.
Комментарий должен максимально подробно описывать метод или свойство или локальный комментарий.
Комментарии должны содержать всю информацию о передаваемых хранимых и возвращаемых параметрах.
Обязательно прилагайте в комментарии пример использования