Рекомендации по написанию чистого PHP-кода
Трудно сразу понять, хорошо ли написан код. Поэтому существуют определенные рекомендации по написанию кода: руководство по PHP, теоретическая информатика, рецензии других программистов и шестое чувство. Это порождает много правил.
Основная цель этого документа состоит в том, чтобы собрать все эти правила и рекомендации в одном месте, чтобы их было легко читать, понимать и применять на практике в своем коде. Это документ-ссылка, в котором любой найдет способ улучшить свой код.
Очевидно, что правил очень много и некоторые ещё только будут добавлены.
- Это не окончательный стандарт написания кода: утверждать, что любой код 100% совместим с данными рекомендациями бессмысленно. Медали за это не дают.
- Не используйте все правила сразу: будет очень сложно применить их все в одно время и в одном коде. Потому что некоторые правила порождают слишком много наблюдений (попробуйте воспитать кавычки), а некоторые из них могут быть противоречивы.
- Совершенно нормально ненавидеть некоторые правила: это лишь рекомендации. Их первостепенная задача - ознакомить вас с правилами, их описанием, сильными и слабыми сторонами. Лишь после этого вы примените некоторые из них, а остальные будете ненавидеть и это нормально.
Если не указано иное, все содержание лицензировано на условиях лицензии Creative Commons Attribution License.
Копия лицензии включена в репозитории.
ClearPHP был создан Damien Seguy. Следующие люди внесли свой вклад в развитие проекта:
- Derick Rethans (https://github.com/kitsched)
- fneuneu (https://github.com/Fneufneu)
- Gary Jones (https://github.com/GaryJones)
- Guillaume Deviart (https://github.com/GuillaumeDievart)
- MozMorris (https://github.com/MozMorris)
- Phil Sturgeon (https://github.com/philsturgeon)
- Victor Stanciu (https://github.com/victorstanciu)
- Juliette Reinders Folmer (https://github.com/jrfnl)
Чтобы предложить новое правило надо:
- форкнуть этот репозиторий, создать ветку, переключиться на неё, добавить правило в ветку
proposition, запушить ветку в Github и отправить пул-реквест - присоединиться к нам в почтовой рассылке