Coding Standards
- 1. Twinslash © 2010 Стандарты кодирования
- 3. Условия хорошего кода Использование стандарта написания кода
- 5. Использование эффективных и понятных архитектурных решений
- 6. Общие стандарты Стандартный отступ пробелами (2 пробела)
- 7. Строка 80-120 символов (в размер экрана)
- 8. Файлы в кодировке UTF-8
- 10. Стандарт кодирования PHP Основан на: Стандарт PEAR http://pear.php.net/manual/ru/standards.php
- 11. Стандарт symfony http://trac.symfony-project.org/wiki/HowToContributeToSymfony#CodingStandards
- 12. Нотации кода Верблюжья нотация: $myVariable , class NewReport (первая буква заглавная в зависимости от условий)
- 13. Подчеркнутая нотация: $my_variable
- 14. Оформление текста и файлов, основные правила Файлы не содержат закрывающего тега PHP ?>
- 15. Каждый класс содержится в отдельном файле, имя которого совпадает с именем класса и оканчивается на .class.php
- 16. Оформление текста и файлов, основные правила Открывающая и закрывающая фигурные скобки всегда располагаются каждая на отдельной линии. if ( $a > 0 ) { $a = 4 ; } class User { public function getAge () { } }
- 17. Оформление текста и файлов, основные правила Арифметически операторы, операторы условий и оператор присваивания всегда обрамляются пробелами. if ( $age > 5 && $rate > 50 ) { $wineStatus = 'good' ; }
- 18. Соглашения об именах Встроенные переменные PHP true , false и null должны быть написаны в нижнем регистре .
- 19. Соглашения об именах $isCreated = true ; $count_degrees = 40 ; Имена переменных -- в верблюжьей нотации с маленькой буквы Иногда допустима подчеркнутая нотация.
- 20. Соглашения об именах function count_events ( $user ) { //... } Имена функций в подчеркнутой нотации.
- 21. Соглашения об именах define ( 'PROJECT_VERSION' , '1.2' ) ; class User { const AGE_MAX = 90 ; } Константы и константы классов: все заглавные буквы с подчеркиваниями вместо пробелов
- 22. Соглашения об именах class User { } class transinetUser extends sfUser { } Имена классов в вербльюжьей нотации с заглавной буквы, если не определен префикс-namespace в symfony
- 23. Соглашения об именах class Car { public $numOfWheels = 4 ; protected $engine = null ; public function getWheels () { //.. } } Методы и свойства классов в верблюжьей нотации с маленькой буквы. Подчеркивание для protected и private не используется .
- 24. Соглашения об именах Имена переменной, класса, функции должны нести четкое описание своего назначения. Для переменных с ролью флага имена наподобие $isSomething , $useSomething
- 25. Для переменных даты $somethingAt или $dateOfSomething
- 26. Соглашения об именах Для переменных с указанием на количество $numOfSomething или $somethingCount
- 27. Для методов получения или установки какого-то внутреннего состояния де-факто стандарт имена вида getSomething() и setSomething($value)
- 28. Для методов получения строки для вывода названия типа renderSomething()
- 29. Массивы $someArray = array ( 'foo' => 'bar' , 'spam' => 'ham' , 'bzz' => array ( 'bzz1' , 'bzz2' ) ) ; Объявление массива более чем из одного элемента необходимо разбивать на несколько строк по элементам
- 30. Управляющие структуры Управляющие структуры включают в себя операторы if , for , while , switch
- 31. В управляющих структурах между ключевым словом и открывающей круглой скобкой должен находиться пробел, чтобы отличать их от вызова функций.
- 32. Необходимо использовать фигурные скобки в любой управляющей структуре, независимо от того, сколько строк она занимает
- 33. Управляющие структуры // некорректно!!!111 if ( $i > 0 ) $i += 4 ; // корректно if ( $i > 0 ) { $i += 4 ; }
- 34. Управляющие структуры Синтаксис оператора switch switch ($ condition ) { case 1 : action1() ; break ; case 2 : action2() ; break ; case 3 : default : defaultaction() ; break ; }
- 35. Управляющие структуры Сложные условия выбора рекомендуется разбивать на несколько строк или упрощать if ( $condition1 || $condition2 || $condition3 ) { // code here }
- 36. Комментарии Подходят комментарии в стилях C ( /* */ ) и C++ ( // ), комментарии в Perl стиле ( # ) не используются Комментарии располагаются на предшествующей строке. // переменная имени $name = 'preved' ;
- 37. Классы Имена классов должны быть удобочитаемыми и понятными.
- 38. Избегайте использования аббревиатур там, где они не являются общепонятными.
- 39. Имя класса начинается с большой буквы или префикса "имени пространства", специфичного для проекта или библиотеки.
- 40. Классы class Toolbar { } class phUser extends sfUser { }
- 41. Классы Все константы и свойства класса располагаются в начале по убыванию видимости, далее располагаются все методы по убыванию видимости. class Car { public $numOfWheels = 4 ; protected $engine = null ; public function getWheels () { //.. } protected function loadWheels () { } }
- 42. HTML и HTML c внедренным PHP Необходимо использование отступов, выделение структуры HTML
- 43. При включении PHP использовать короткие теги
- 44. Управляющие функции имеют вид if: elseif: endif, foreach: endforeach и т.д.
- 45. Вместо switch используется цепочка if else
- 46. HTML и HTML c внедренным PHP < div > <? if ( $user ) : ?> < strong > <? = $user [ 'name' ] ?> </ strong > <? endif ?> </ div >
- 47. HTML и HTML c внедренным PHP Недопустимо написание многострочных блоков кода внутри тегов PHP и использование фигурных скобок.
- 48. YML файлы Каждый элемент необходимо стремиться располагать в отдельной строке UserProfile : columns : name : type : string length : 255 status : type : enum values : - active - unactive - pending default : active
- 49. SQL Имена полей и таблиц в подчеркнутой нотации.
- 50. Имя таблицы: модель данных, которую она представляет, в единственном числе .
- 51. Поле связи с другой таблицей должно в себе содержать указание на таблицу <имя таблицы>_<имя поля связи>
- 52. SQL Название полей должно в достаточной степени указывать на их тип (аналогично переменным и функция PHP)
- 53. Рекомендуется для булевых полей использовать название вида is_...
- 55. SQL Внутри запросов SQL (и схожих) инструкции пишутся заглавными буквами, имена таблиц и колонок строчными.
- 56. Сложные SQL запросы следует разбивать на несколько строк по операторам и колонкам.
- 57. SQL SELECT t.id, t.owner_sf_guard_user_id, t.created_at, t.is_draft FROM event t WHERE t . ended_at > NOW ()
- 58. Спасибо за внимание Вопросы?