Соглашения об именах всегда были важной темой в программировании, потому что у каждого есть свое мнение о том, как их следует называть. Есть много общих, например, некоторые строки метки как «str», а затем имя, то есть: «strUsername» — это хороший, очевидный способ запомнить тип данных, но он может запутаться, например, при переключении типов данных. , если у вас есть функция и вам нужно передать ей строку или массив и проверить, что именно отправлено, как она будет работать? Вы назовете его «строрарр»? Крайне маловероятно, поскольку это не имеет логического смысла. Следовательно, разработчик должен установить собственную схему соглашения об именах, удобную для него, а также легко понятную.

Вот мой взгляд на соглашения об именах:

  1. Именование должно быть точным, понятным и легко находимым.
    Это означает, что больше не нужно называть каждый запрос словом «запрос» — вместо этого нужно быть более сфокусированным, например, для вопроса об учетной записи в функции с именем «getAccountInformation» назовите переменную $accountInformationQuery вместо $query, поэтому, если вам нужно быстро сослаться на нее, найдите getAccountInformation ИЛИ $accountInformationQuery.
  2. Называйте имена разумно! Нам не нужны 64-символьные имена переменных или функций, поэтому сделайте их короткими, простыми и уникальными!
  3. Добавьте комментарий! Конечно, вы можете точно знать, что делает эта переменная/функция, но знает ли другой человек? Всегда полезно добавить небольшой комментарий, который говорит, что он делает, например, $accountInformationQuery может иметь комментарий «Эта переменная [$accountInformationQuery] использует базу данных [$DM] и запрашивает информацию об учетной записи пользователя и выполняет поиск по его идентификатору. номер, который уникален для каждого пользователя».

Вот практический пример перечисленных выше предложений в PHP:

Как видите, код хорошо документирован, чист и понятен всем, кто его читает. Он имеет чистое соглашение об именах и имеет смысл. Итак, всем разработчикам: назовите имена!