如何让Doxygen忽略指定命令(如@note)?
配置Doxygen忽略指定命令的方法
要让Doxygen生成文档时忽略@note或其他指定命令,有两种常用配置方式:
通过别名覆盖(推荐全局忽略)
打开Doxygen配置文件(通常命名为Doxyfile),找到ALIASES配置项,将需要忽略的命令映射为空字符串:- 仅忽略
@note的配置:ALIASES += "note=" - 同时忽略多个命令(比如
@note和@warning):ALIASES += "note=" "warning="
配置生效后,Doxygen处理注释时会直接跳过这些命令对应的内容。
- 仅忽略
通过条件注释包裹(适合局部忽略)
如果仅需忽略某几处特定的命令内容,而非全局禁用该命令,可以用@cond和@endcond包裹需要忽略的部分:/** * @brief Some func. * * @param a * @param b * @return int * @cond IGNORE * @note Some note * @endcond */ int some_func(int a, int b);同时在Doxyfile中添加:
ENABLED_SECTIONS = IGNORE这种方式只会忽略被包裹的指定内容,不影响其他位置的同命令使用。
内容的提问来源于stack exchange,提问作者Martel
相关产品推荐
相关产品推荐

