Как написать SDK по канону?

Question

[Игорь]

Существуют ли какие либо негласные/гласные законы или правила хорошего тона для написания SDK на PHP?

По сути я могу написать все одним классом, но если посмотреть на VK-PHP-SDK или TelegramBot, то я вижу огромное количество классов которые в свою очередь находятся в разных папках и тп. Не думаю что столь большие IT компании делают это от "нечего делать".

UDP: Я понимаю что 100500 методов в одном классе - это не гуд. Я понимаю что код должен сопровождаться PDP DOC. Я имею ввиду, должен ли я описывать типы, ошибки и тд?

Comments

[ThunderCat]

все зависит от объема кода и сложности апи, если у вас 10 методов в апи то и огород городить не стоит, все в 1-2 класса можно закинуть, а если 200 - стоит разбить на модули.

[Игорь]

ThunderCat, Это да, я понимаю, я не правильно вопрос сформулировал. Я отредактировал. Буду благодарен если вы дополните ответ.

Answer 1

[DevMan]

одна задача - один класс.
один класс - один файл.

а дальше все зависит от собственного чувства прекрасного.

Comments

[Игорь]

Это да, я понимаю, я не правильно вопрос сформулировал. Я отредактировал. Буду благодарен если вы дополните ответ.

[DevMan]

Игорь,

должен ли я описывать типы, ошибки и тд?

не должны. но будет полезным если делаете продукт для людей.
где это будет описано: в коде или доке – особого рояля не играет.

[Игорь]

DevMan, В доке в смысле в PHP DOC или просто в документации? А в коде типы как описываются обычно?

[DevMan]

Игорь,

В доке в смысле в PHP DOC или просто в документации?

зависит от того как вы ведете доку.
ведете в phpdoc – пишите в ней.
ведете отдельно – пишите отдельно.

А в коде типы как описываются обычно?

так как сами решите:
можно на уровне документации.
можно на уровне аннотаций.
можно на уровне type declaration/type hinting.

поймите: нет единственно верных правил/подходов; есть то, что подходит/устраивает и нет.

Answer 2

[Stalker_RED]

Конечно ты можешь написать одним классом, но это будет god object, и хорошим такой подход никто не назовет.
Пока люди делают маленькие проекты для себя - они могут писать как им нравится. Но когда проект большой, и код показывают другим людям (заказчикам/клиентам/whatever) то приходится следовать правилам хорошего тона, ага.

Comments

[Игорь]

whatever это... ?

[Stalker_RED]

Игорь, это на секретном языке, который знают только программисты. И то не все.

[Игорь]

Stalker_RED, Ну если переводить, то это "без разницы". Заказчики/клиенты и неважно кто?

[Игорь]

Stalker_RED, Кажется я не правильно вопрос сформулировал. Я отредактировал. Буду благодарен если вы дополните ответ.

[Stalker_RED]

Игорь, вот представьте, что одному ребенку дали конструктор лего поиграться, а другому - пластиковый кирпич и напильник. В теории они оба могут из этого сделать крепость, или там звездолет, или что им надо. Но один это сделает играючи, а другому придется помучиться.
Получается что лего - хороший SDK, а кирпич+напильник - плохой.

И вот вы спрашиваете, надо ли вам в ваш "набор для разработке софта" добавлять какие-то полезные штуки, или и так сойдет. Выбор за вами, конечно же. Но пользователи потом оценят, хорошо ли получилось.