前端之家

  1. 首页
  2. 问答

在Doxygen中共享具有多种功能的数据格式规范

• 问答

给出类似这样的内容：

/**
 * @brief FuncA
 *
 * Data format:
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 *
 */
void funcA()
{}

/**
 * @brief FuncB
 *
 * Data format:
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 *
 */
void funcB()
{}

我该如何排除数据格式规范，以便它不会在多个地方重复？我想要的是这样的：

/**
 * @magictag Data Format
 *
 * INT32 Date
 * INT32 Time
 * FLOAT Value
 */

/**
 * @brief FuncA
 *
 * Data format:
 * @ref DataFormat
 *
 */
void funcA()
{}

/**
 * @brief FuncB
 *
 * Data format:
 * @ref DataFormat
 *
 */
void funcB()
{}

我只想拥有一个通用的文档文档，我可以从任何地方引用它。谢谢。

a23864615 回答：在Doxygen中共享具有多种功能的数据格式规范

doxygen当前版本为1.8.16，建议升级至该版本。在版本1.8.11中，\snippetdoc不起作用（此版本中不存在命令）。

\copydetails 的示例：

/** \file */

/**
 * @brief FuncA
 *
 * Data format:
 * - INT32 Date
 * - INT32 Time
 * - FLOAT Value
 *
 */
void funcA();

/**
 * @brief FuncB
 *
 * @copydetails funcA
 */
void funcB();

\snippetdoc 的示例：

/** \file */

/**
 * @brief FuncC
 *
 * @snippetdoc this snip_data
 *
 */
void funcC();

/**
 * @brief FuncD
 *
 * @snippetdoc this snip_data
 */
void funcD();


/*
 [snip_data]
  Data format:
  - INT32 Date
  - INT32 Time
  - FLOAT Value
 [snip_data]
*/
doxygen
本文链接：https://www.f2er.com/2938165.html

大家都在问