You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

C++中Doxygen文档注释添加参考文献章节的标准方法

在Doxygen中添加独立参考文献章节的方法

Doxygen没有内置的@references标记,但可以通过以下几种标准方式实现你要的独立参考文献章节:

1. 手动用@section定义章节

直接在注释里添加带标题的章节块,生成的文档会把这部分单独列为一个小节:

/**
 * @brief Return laplacian as linear operator on u(x,y) assuming homogenous dirichlet BCs.
 * 
 * @param n Number of grid points in the x or y direction.
 * @return Eigen::SparseMatrix<double> 
 * 
 * @section laplacian_refs 参考文献
 * [1] MIT Intro Linear PDEs
 * [2] 其他相关参考文献内容
 */
Eigen::SparseMatrix<double> laplacian(size_t n);

这里laplacian_refs是章节的唯一标识(可自定义),后面是显示的标题。

2. 用@par标记生成独立段落块

如果不需要正式的章节编号,用@par可以生成一个带标题的独立内容块,视觉上和正文明确区分:

/**
 * @brief Return laplacian as linear operator on u(x,y) assuming homogenous dirichlet BCs.
 * 
 * @param n Number of grid points in the x or y direction.
 * @return Eigen::SparseMatrix<double> 
 * 
 * @par 参考文献
 * [1] MIT Intro Linear PDEs
 * [2] 其他相关参考文献内容
 */
Eigen::SparseMatrix<double> laplacian(size_t n);

3. 自定义@references别名(最接近你的预期)

如果想统一用@references标记,可以在Doxygen的配置文件(Doxyfile)中添加别名定义:

ALIASES += "references=@section references 参考文献"

之后就能像你预期的那样直接使用@references,生成独立章节:

/**
 * @brief Return laplacian as linear operator on u(x,y) assuming homogenous dirichlet BCs.
 * 
 * @param n Number of grid points in the x or y direction.
 * @return Eigen::SparseMatrix<double> 
 * 
 * @references
 * [1] MIT Intro Linear PDEs
 * [2] 其他相关参考文献内容
 */
Eigen::SparseMatrix<double> laplacian(size_t n);

如果是通过CMake生成Doxygen文档,需要确保这个别名配置被正确写入Doxyfile,或者通过doxygen_add_docs命令传递对应的配置参数。

内容的提问来源于stack exchange,提问作者Jared

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.28 15:46:27