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

Doxygen中派生类函数复用基类文档的语法是否有效?

Doxygen派生类函数继承基类文档的正确处理方式

你用的//! (derived)这种注释语法无法被Doxygen识别,没法实现让派生类函数继承基类文档的需求。

要实现既不重复编写文档、又能保留基类内容的效果,有几种靠谱的写法:

  • 使用\copydoc命令,直接复制基类对应函数的完整文档:
class Child : public Base {
    //! \copydoc Base::Foo()
    void Foo() override;
};
  • 使用\inheritdocs命令(Doxygen 1.8.11及以上版本支持),它会自动继承基类文档,还能在后面追加派生类的额外说明:
class Child : public Base {
    //! \inheritdocs
    //! 派生类对Foo函数的额外实现说明
    void Foo() override;
};
  • 另外,如果Doxygen配置里的INHERIT_DOCS选项是开启状态(默认开启),派生类函数如果不写任何文档注释,会自动继承基类的文档内容。不过这种方式不够直观,建议用前面两种命令明确标注继承关系。

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

相关产品推荐
方舟 Agent Plan

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

最近更新时间:2026.07.09 23:44:53