使用cpp文件中的现有代码范围作为文档示例

Question

我可以使用现有代码范围（意味着cpp文件中的某些代码行）作为doxygen文档中的示例吗？

/*!
 * \brief My Foo class
 * \details More about foo
 * \example?? Foo used like here, some LOC from cpp follow (how can I do that??)
 */
class Foo  

我想展示3-10行现有代码，了解我如何使用Foo。那些3-10行应该来自cpp文件。

我知道我必须使用cpp标记\file文件，但是如何在那里引用一些代码？

像这样（不正确的伪代码，因为我不知道该怎么做）

somewhereelse.cpp
...
...
//! \example Foo (supposed to display with Foo docu). This is how Foo is used
//! @{
Foo f;
f.init(); // init first
f.start(); // then start
//! }@
...

Answer 1

正如阿尔伯特所指出的（上面的评论）\snippet可以使用。可在此处找到完整示例https://stackoverflow.com/a/16034375/356726

您引用一个文件并在该文件中（我的方案中为.cpp），您可以通过[]括号标记该块。然后它将显示为代码块。