【问题标题】:How to add Doxygen Comments for "C" variables with long type names如何为具有长类型名称的“C”变量添加 Doxygen 注释
【发布时间】:2023-10-27 03:49:01
【问题描述】:

我有代码

静态 const guint8 变量;

当我放文档时

/** * \var 静态常量 guint8 变量; * \brief 这是一个变量 */ 静态 const guint8 变量;

我在生成的文档中没有得到任何输出。但是,当使用简单的变量减速完成同样的事情时:

/** * \var int someothervar; * \brief 这是其他一些变量 */ 整型变量;

确实有效

是我在使用上犯了一些错误吗?

提前感谢您的帮助,

- 电车

【问题讨论】:

  • 这一定是 Doxygen 中的一个错误。

标签: doxygen


【解决方案1】:

要提取静态变量,您应该将 EXTRACT_STATIC 设置为 YES。

如果文档在变量前面,则不需要(也不应该使用)\var

要么将 EXTRACT_ALL 设置为 YES,要么在代码中使用 @file 命令添加注释以记录文件本身。

【讨论】: