文档中的可测试示例

时间:2019-10-16 20:14:42

标签: php testing automated-tests phpunit documentation

我正在用PHP创建一个库。我想提供一个带有示例的不错的教程。如何确保示例正确无误?

该库已通过PHPUnit测试。我正在考虑如何以一种简单而优雅的方式将可执行代码与富文本混合在一起,以便于维护。

我不想从演示应用程序或测试中复制示例,因为文档会因代码中的每一次更改而过时,并且我不能保证该教程仍然有效。

我的想法是以某种方式将代码片段包含在文本中,以使样板远离文档。或者以其他方式运行文档的一章作为测试。

您对此有任何想法或经验吗?

谢谢。

0 个答案:

没有答案