Есть ли такая книга-учебник по PHP, в которой описан стиль программирования близкий к эталону?

Question

[Роми]

У меня есть проблема: я умею писать рабочий код, и с этим проблем нет, но если этот код попадает на более-менее придирчивое ревью - его зачастую разносят в пух и прах ))

При этом, ревьювер зачастую ссылается на какие-то неведомые мне стандарты и правила, которые, дескать, "и так все знают" :-)

Вот я и подумал:

- А существует ли где-то книга-учебник с такими вот правилами, следуя которым можно писать такой код, к которому уж точно никто не придерется?

Нет, я прекрасно понимаю, что придраться можно к любому коду ))))))) Почему в каске? Почему без каски? Почему в скобочках? Почему без скобочек? ))

Но тем не менее. Есть ли такая книга по PHP, и как она называется?

Спасибо.

Comments

[ThunderCat]

PSR?

[Сергей delphinpro]

В мире PHP есть рекомендации в стандарты https://habr.com/ru/post/458484/

[Роми]

ThunderCat, это о другом )

[ThunderCat]

Роми,
https://phptherightway.com/
https://phptherightway.ru/

[Vitsliputsli]

Роми, стандарт в php - это PSR. В ООП почти все признают SOLID и наверное GRASP, но это не стандарты, а принципы, т.к. не несут чётких требований. Всё остальное, ещё менее чёткое и ещё более спорное, в том числе шаблоны проектирования.

[Роми]

ThunderCat, да, хороший ресурс, читал :) спасибо.

Answer 1

[Василий Банников]

При этом, ревьювер зачастую ссылается на какие-то неведомые мне стандарты и правила, которые, дескать, "и так все знают" :-)

Это плохое ревью, и на какие-либо стандарты и нормы надо ссылаться.

- А существует ли где-то книга-учебник с такими вот правилами, следуя которым можно писать такой код, к которому уж точно никто не придерется?

Нет, тк не существует эталона.

Есть общие правила, про архитектуру, и ООП: чистая архитектура, порты и адаптеры, MVC, CQRS, SOLID, GRASP
Есть общие правила про оформление кода: чистый код, совершенный код (они немного противоречат друг другу), KISS, DRY, YAGNI.

А чтобы было меньше придирок на ревью:
1. Внедри кодстайл, и контролируй его при помощи всяких автоматических инструментов
2. Опиши архитектуру в каких-нибудь внутренних документах в проекте (можно прямо в репу запихать), и при реализации фич опирайся на эти документы.
3. Давай нормальные имена переменным, и избегай всяких code smell-ов, и антипаттернов
4. Пиши тесты

Comments

[Роми]

1. Внедри кодстайл, и контролируй его при помощи всяких автоматических инструментов

Как это? Например?

[Роми]

...в общем, есть ли такая книга где все это разжевывается в примерах? :)

[Василий Банников]

Роми, не шарю, как это на php делается, но например в го есть gofmt, в C# есть dotnet-format + .editorconfig, в JS есть eslint. Что-то подобное должно быть и на php.

Смысл в том, что перед коммитом ты запускаешь форматирование кода, и он уже у тебя будет отформатирован по принятому стандарту, а не так как тебе или твоему редактору вздумалось

[Василий Банников]

Роми, Вот то что я нашёл (на php реально какой-то зоопарк)
https://habr.com/ru/company/oleg-bunin/blog/487260/
php -l
https://github.com/squizlabs/PHP_CodeSniffer
https://github.com/FriendsOfPHP/PHP-CS-Fixer
https://github.com/badoo/phpcf/

[Владислав Лысков]

Василий Банников, тут не нужна книга, есть psr, соблюдать достаточно, если нет от него отступлений, согласованных командой

[Роми]

Василий Банников, любопытные штуки)) не верится что это что-то действенное но я попробую ))

а плагинов для VSC случайно таких нет?)) какую фразу гуглить надо?

[Siverius]

Роми, https://github.com/squizlabs/PHP_CodeSniffer

[ThunderCat]

Василий Банников,

на php реально какой-то зоопарк

Стандартом в отрасли идет пхпсторм/вебсторм, там есть команда отформатировать код, оно причесывает все : хтмл, пхп, жс, цсс...

[Василий Банников]

ThunderCat, а как это в рамках ci/cd делать (например проверку в PR, что код отформатирован)?
А что делать, если у кого-то из членов команды нет phpstorm?

[ThunderCat]

Василий Банников,

а как это в рамках ci/cd делать (например проверку в PR, что код отформатирован)?

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

А что делать, если у кого-то из членов команды нет phpstorm?

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

[Василий Банников]

ThunderCat,

К тому же, в силу популярности языка, на многие иде есть плагины, которые умеют то же самое.

И у каждой свой конфиг?

[mkone112]

Василий Банников, вопрос не ясен.

[Василий Банников]

mkone112, перефразирую.

К тому же, в силу популярности языка, на многие иде есть плагины, которые умеют то же самое.

И для каждого из десятков плагинов надо свой конфиг в репозиторий класть, чтобы у всех был единый кодстайл?

[mkone112]

Василий Банников, для каждого из десятков плагинов для webstorm?

[Василий Банников]

mkone112, на многие иде есть плагины
Ну тоесть видимо для vim/vscode/atom/brackets/notepad++/phpstorm
Говорю же - не шарю в этом вашем пхп, и не особо хочу залезать, по тому выводы строю исключительно на словах в треде

[mkone112]

Василий Банников, все гораздо проще. Если человек юзает не webstorm - это сугубо его личные проблемы, вне зависимости от яп.

Answer 2

[Siverius]

А можно пример таких отсылок к неведомым стандартам или пример кода, который не прошёл ревью? Если это не PSR