记录Boost.Test测试用例

问题描述：

有没有任何方法可以对使用Boost.Test宏定义的测试用例使用文档注释？我可以使用Doxygen风格的评论，他们会被正确解析？记录Boost.Test测试用例

根据doxygen [预处理文档]（http://www.stack.nl/~dimitri/doxygen/preprocessing.html），应该可以用普通的doxygen样式注释来记录这些测试，但您可能必须花费一点时间在配置文件中使用'predefined'标志。在[this]（http://www.stack.nl/~dimitri/doxygen/preprocessing.html）页面的一半处查看'IUnknown'类示例。 – Chris 2012-03-13 08:17:11

答

答案是让你的测试用例如此简单，明显，可读性强，以至于你写的任何文档都是多余的。请参阅我的rewrite of the Boost.Test docs中标题为Test Case Maintenance and Design的部分。

是的，这当然不用说了，但我认为在测试中有一个附加到该类的所有测试用例的列表是很好的，所以文档显示了这个和测试的内容。 – Rene 2015-10-27 16:38:33

这增加了一个额外的维护负担，这是不合理的IMO。实际的评论已经与代码不同。软件工程的趋势一直是[直接在代码中表达思想]（https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-direct），而不是依靠评论或其他元数据码。 – legalize 2015-10-27 20:37:43

记录Boost.Test测试用例

相关推荐