Регулярно ли держать имена методов, классов и функций организованными?

Question

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

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

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

Большое спасибо!

Answer 1

Один стандарт, который вы можете принять, - это Стандарты Zend Framework

Answer 2

Взгляните на Стандарты кодирования PEAR . Он довольно всеобъемлющий и облегчит задачу, если вы когда-нибудь будете использовать какие-либо груши.

Это также может помочь при поиске CRUD (Create Read Update Delete) в Википедии.

Что касается единственного и множественного числа, я стараюсь придерживаться концептуального стиля моего кода. Я обнаружил, что с ООП имена объектов, как правило, легче оборачивать, когда вы используете единственное число.

Даже если ваш класс будет содержать информацию о нескольких Собаках, вместо того, чтобы называть ее Собаками, назовите ее как-нибудь еще, например, Пак, даже если технически это не стая. Проще сосредоточить внимание на нескольких Стаях, чем на нескольких Собаках, и «стая» концептуально сильнее, чем аморфная группа «собак». «Собаки» не похожи на один объект, в то время как «стая» звучит.

Полагаю, это очевидный пример, но если ваш класс будет использоваться только для определения объектов на индивидуальной основе, не делайте его множественным. Или, если ваша функция собирается форматировать только одну строку за раз, не называйте ее formatStrings ().

Массивы немного отличаются. Если вы используете массив для списка всех своих собак, вы не назовете его $ pack, потому что вы ожидаете, что он будет содержать информацию о стае. Вместо этого вы бы назвали это $ dogs.

Answer 3

Вы можете взглянуть на следующее: http://www.dagbladet.no/development/phpcodingstandard/

Моя работа реализовала это, и хотя я не всегда согласен, по крайней мере, это порождает последовательность.

Answer 4

Сядьте со своими коллегами, объясните проблему, за которой вы наблюдаете разработку, и затем запишите стандарт, с которым вы все согласны.

Как вы определили, единственная проблема - это согласованность.Поэтому не убеждайте себя, что вам также нужен стандарт, который научно доказано, чтобы быть оптимальным.

Answer 5

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