我正在创建一个库,我想提供一个关于如何使用这个库的教程。这样的教程将包含代码片段作为使用示例;因此,我想测试这些代码段以确保代码是正确的。
如何在文档中测试示例?
我正在考虑将文档文本与传统的单元测试交织在一起,但我所有的想法似乎都缺乏优雅。一种选择可能是将phpdoc注释添加到测试中,然后以某种方式创建源代码的web/可打印版本。另一种方法可能是引用Markdown文档中的测试片段。无论哪种方式,都需要某种工具来将事物组合在一起,我更愿意使用现有的工具。
这个库是用PHP编写的,它使用PHPUnit进行测试,但是不管使用哪种语言,我都在寻找灵感。
(注意:我最初在堆栈溢出上已发布了这个问题,但它并不适合这里。)
发布于 2019-11-11 22:11:38
https://softwareengineering.stackexchange.com/questions/400918
复制相似问题