Я создаю библиотеку на PHP. Я хотел бы предоставить хороший учебник с примерами. Как убедиться, что примеры верны?
Библиотека протестирована с PHPUnit. Я думаю о том, как смешать исполняемый код с форматированным текстом простым и элегантным способом, чтобы его было легко поддерживать.
Я не хочу копировать и вставлять примеры из демонстрационного приложения или тестов, потому чтодокументация устареет при каждом изменении в коде, и я не могу гарантировать, что учебник все еще работает.
Моя идея состоит в том, чтобы каким-то образом включить фрагменты кода в текст, чтобы сохранить шаблон от документации. Или наоборот: запустить главу документации в качестве теста.
Есть ли у вас какие-либо идеи или опыт по этому поводу?
Спасибо.