Давайте поясню.
Безусловно, документация должна быть у любого проекта, ведь она упрощает работу с вашим кодом. Но написать хорошую документацию – задача не из легких: нужно учесть множество нюансов и сделать так, чтобы её понял любой разработчик.
💡 Но даже при наличии качественной документации, исходный код по-прежнему остается наилучшим источником информации.
Недавно столкнулся с этим, когда разбирался с библиотекой PHP IMAP для чтения почты клиента. Документация там минимальная: установка, пара примеров, и на этом всё. Никакого описания методов, их аргументов или возможных исключений. Пришлось по старинке читать исходный код, чтобы понять, как с этим работать.
И знаете что? Это сработало! 😎 Заглянув в код, я быстро нашел нужные методы и понял, какие параметры им нужно передавать.
Так что, если вдруг столкнетесь с недокументированным функционалом, не стесняйтесь разбираться в исходном коде. Он по-прежнему остается самой лучшей документацией. 👌
👨🦳 В те времена, когда мы начинали, так и работали – документации почти не было, и выживал тот, кто умел читать код.
Свята место | Чат | Бот | Boosty