Стандарт оформления кода (стиль программирования) (англ. coding standards, coding convention или programming style)
Предлагаю, для ознакомления, часть текста документа, который я разработал для себя и своей команды. Основа взята с framework.zend.com/manual/ru/coding-standard.html, часть с PEAR и самая важная часть, из собственного опыта программирования. Я не жду единогласного признания т.к. каждый программист привык к тому к чему привык и, что-то другое для него будет не удобным и неправильным.
По запросу могу предоставить полный текст документа, всего 16 страниц выверенного текста.
Может размещу стандарты работы с БД MySQL, порядок работы с Git и руководство по написанию PHPUnit тестов.
Оглавление
- Формат файлов3
- Кодировка3
- Форматирование PHP-файлов3
- Общее3
- Отступы3
- Максимальная длина строки3
- Соглашения по именованию3
- Директории3
- Классы3
- Интерфейсы4
- Имена файлов4
- Функции и методы4
- Переменные и свойства5
- Константы5
- Стиль кодирования5
- Обрамление PHP-кода5
- Строки5
- Строковые литералы5
- Строковые литералы, содержащие апострофы6
- Подстановка переменных и конкатенация строк6
- SQL запросы6
- Массивы7
- Массивы с числовыми индексами7
- Ассоциативные массивы7
- Классы8
- Определение класса8
- Переменные-члены классов9
- Функции и методы9
- Определение функций и методов9
- Использование функций и методов11
- Вызовы функций и методов11
- Управляющие структуры12
- If / Else / Elseif12
- Switch13
- Комментарии14
- Встроенная документация14
- Файлы14
- Классы14
- Функции15
