技术咨询:Doxygen是否支持文件嵌入命令,使嵌入内容等价于直接编写
Doxygen嵌入外部文件的实现方案
Doxygen提供了\input命令,恰好满足你的需求——它可以将外部文件的内容嵌入到源文件的注释块中,并且会把嵌入内容当作源文件内直接编写的注释内容解析,最终让两种变体生成完全一致的输出,非常适合大段文本拆分管理的场景。
正确实现示例
变体A(直接编写注释)
// --- SourceFile.c --- /*! \brief description * \details description */
变体B(使用\input嵌入外部文件)
// --- SourceFile.c --- /*! \brief description * \input file.txt */
对应的外部文件file.txt内容:
\details description
关键说明
\input会读取指定文件的全部内容,插入到注释的对应位置,并且完全解析其中的Doxygen命令(比如示例中的\details),生成的文档和变体A完全一致。- 文件路径支持相对路径(相对于源文件所在目录或Doxygen配置的
INPUT_PATH)或绝对路径。
内容的提问来源于stack exchange,提问作者Dgo
相关产品推荐
相关产品推荐

