我有一个主要用C++编写的小项目,它是用but编写的,并使用一个单元测试框架进行测试(在我的例子中,Google,但这并不重要)。我为每个类的每个方法编写了几个测试用例,以测试该方法在不同条件下的行为,我想为测试套件留下一些注释。DO2文档是为projet的用户设计的,他们很可能不想看到项目实施细节和测试的文档。
我想知道单元测试文档的共同策略是什么?不要对它们进行任何评论,并将测试本身视为文档?或者在测试文件中留下非doxygen的注释?还是使用doxygen的ENABLED_SECTIONS
选项有条件地编译测试文档?
发布于 2016-07-07 13:30:43
ENABLED_SECTIONS
是该走的路。然后,您可以轻松地为那些想要它们的人(您自己、同事、维护人员)和那些不需要它们的人(项目的用户)打开它们。
这就是我们所做的&它工作得很好。
https://softwareengineering.stackexchange.com/questions/324246
复制相似问题