Я заинтересован в ООП php. Существует множество учебных пособий по созданию классов, но они не нашли хорошего объяснения веб-php ООП. Я имею в виду следующее:
Моя цель — сделать надлежащую документацию — как код должен быть написан, чтобы можно было легко документировать?
1 — Вы можете иметь несколько классов в одном файле. Нет проблем с этим вообще. Однако вы можете сделать это с одним классом на файл, если это поможет вам лучше организовать ваш код.
2 — То же. Однако, если вы хотите сделать что-то таким образом, у вас будет тысячи файлов в большом проекте. Не очень хороший выбор.
Взгляните на phpdoc.org
и это: http://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code—net-8118
Некоторые PHP IDE имеют инструменты для автоматизации и правильной документации. Проверьте PHPStorms, например. Это одна из лучших PHP IDE и отличные инструменты документирования.
1 — да. Каждый класс должен жить в своем собственном файле. Это облегчает многие вещи, такие как присвоение имен этим файлам (с использованием имени класса), SRP и, что наиболее важно, автоматическая загрузка.
2 — Здесь я не согласен. Каждый файл должен содержать столько объектов, сколько ему нужно. Каждый домен и классы, представляющие его бизнес-правила, различны, поэтому это действительно зависит от конкретного проекта, над которым вы работаете. Не бойтесь манипулировать множеством различных объектов в одном файле PHP. Просто убедитесь, что сам класс сплочен и не делает слишком много вещей. Будьте проще и старайтесь придерживаться Принцип единой ответственности.
Я думаю, что лучшее место, чтобы начать получать много ответов на подобные вопросы — это PHP-фиг Веб-сайт. Здесь много документации о стандартах, документации, автозагрузке и т. Д.