如何将示例与Doxygen集成？

Question

我记录了所有类,现在我想集成一个如何使用这些类的示例.我怎么做？

Answer 1

您可以将示例源代码放在doxygen配置中定义的特殊路径下EXAMPLE_PATH,然后插入带有@example标记的示例.

然后,Doxygen会生成一个包含示例源的额外页面.它还将从包含示例标记的类文档中设置它的链接.

或者,如果您想使用小代码片段,可以插入它们 @code ... @endcode

这里的文档是: doxygen文档？

Answer 2

另一种方法是使用该\snippet命令.

• 在头文件中写下如下内容:

\section ex1 Example
\snippet path_to_test_class/TestClass.cpp TestClass example
\section ex2 Expected output
\snippet path_to_test_class/TestClass.cpp TestClass expected output

• 在TestClass.cpp文件中,有类似于:

 //! [OptimizeSpeedOnTrackTest example]
 Class c;
 const double res = c.do_something();
 //! [OptimizeSpeedOnTrackTest example]
 //! [OptimizeSpeedOnTrackTest expected output]
 ASSERT_DOUBLE_EQ(5,res);
 //! [OptimizeSpeedOnTrackTest expected output]

path_to_test_class 必须在您的EXAMPLE_PATH中.

这为您提供以下内容:

• 您的示例不仅仅是文档:它们也提供测试覆盖
• 您的测试运行器(和您的编译器)为您提供实例编译和运行的保险
• 它非常适合TDD工作流程