Как правильно писать названия переменных, функций и тому-подобное?

Question

[Михаил Р.]

Всем привет! Изучаю php и возник вопрос в стандартизации правильного (профессионального) написания названий функций, переменных и тому-подобное, и что-бы методом тыка не проверять, решил спросить у профессионалов, как они пишут те и иные названия элементов в коде. Приведу примеры, как пишу это я:
Переменные:
oneTwoThree
Функции:
_oneTwoThree
Название столбцов в БД:
one_two_three
Это самые популярные элементы кода. А как пишите Вы? Возможно, у Вас есть и другие примеры написания других элементов кода?
Спасибо!

Answer 1

[Сергей Протько]

нижнее подчеркивание у функции убираем и все уже чуть получше.

В целом же названия надо делать осмысленными. То есть если не знаем как что назвать, просто формулируем что мы хотим сделать (на английском языке), и исходя из этого уже выдумываем названия:

// calculate sum
$sum = calculateSum(); 
// generate report for premium users
$sum = generateReport(new PremiumUsersSpecification());

как-то так. Ну а что как, у меня такие правила:

- константы - SCREAMING_SNAKE_CASE
- названия объектов - UpperCamelCase
- названия переменных, методов, функций и т.д. - lowerCamelCase
- таблички/поля в бд, json, yml - snake_case

Answer 2

[Alexander]

Логически надо называть.
К примеру нужно реализовать модуль заказы туров.
создаем бд - tour_orders
функции которая возвращает все туры - getAllTours()
функция которая удалаяет тур - removeTour(){}
.....

Comments

[Михаил Р.]

То-есть Вы пишите название функции, как getAllTours? Я видел, что на западе пишут _getAllTours ...

[Alexander]

Mike Ro: все зависит от того как принято в команде. Лично я сам пишу через верблюжию нотацию но, у нас в команде принято через `_` это тока переменные создавать но не функции. Что то типо code style комании.

[Сергей Протько]

Mike Ro: хз где вы такое видели. Обычно нижним подчеркиванием "выделяют" приватные функции/методы, но я считаю это ненужным и снижающим читабельность кода.

[Михаил Р.]

Сергей Протько: понял, учту!

Answer 3

[Николай Филиппов]

Например вот
svyatoslav.biz/misc/psr_translation/#_PSR-1

Answer 4

[Алексей Скобкин]

Я пишу используя наиболее популярные Code Style Guide для языков, на которых пишу.
В случае с PHP это PSR-1, PSR-2 и Symfony Coding Standards (когда пишу для Symfony).
Плюс использую всякие логичные семантические приёмы при именовании методов и переменных.
Код должен быть написан так, чтобы уже по названию каких-либо конструкций можно было понять о них достаточно информации.