Doxygen section缩进异常问题咨询:该现象是否正常?遗漏哪些配置?
Doxygen section缩进问题排查方案
你描述的缩进异常现象如下图:
该表现不属于Doxygen的原生故障,大多是注释写法或配置项不匹配导致,可按以下方向排查遗漏的操作/配置:
- 注释写法问题
若你在@section/@subsection等指令下方的内容前加了多余的前导空格/制表符,Doxygen会保留注释内容的缩进映射到输出页面;另外如果不同层级的section指令嵌套顺序错误,比如@subsection没有对应父级@section,也会出现层级缩进错乱。解决方案是统一section下的内容顶格编写,同时严格按@section→@subsection→@subsubsection的层级顺序嵌套。 - Doxyfile配置冲突
- 检查
MARKDOWN_SUPPORT配置项:如果设置为YES,同时你混用了Doxygen原生的@section指令和Markdown的#标题语法,两种标题规则会冲突导致缩进计算错误,建议统一使用同一种标题写法即可解决。 - 检查
INDENT_CODE配置项:默认值为YES会给代码块自动加缩进,如果你的section内混合了普通文本和无包裹的代码片段,可能会连带触发普通文本的多余缩进,不需要自动缩进可将该值改为NO。 - 检查
HTML_EXTRA_STYLESHEET配置项:如果你自定义了额外的CSS样式,可能给.section相关的DOM元素加了额外的margin或padding属性,可临时移除自定义样式排查是否为样式导致的缩进异常。
- 检查
- 版本兼容问题
1.8.17之前的旧版本Doxygen对section嵌套的缩进处理存在已知缺陷,如果你用的是旧版本可升级到最新稳定版验证问题是否消失。
内容的提问来源于stack exchange,提问作者sorh
相关产品推荐
相关产品推荐

