如何指定Doxygen中@example标签的示例排序顺序?
控制Doxygen示例显示顺序的方法
Doxygen本身没有直接的配置选项修改示例的默认排序(默认按文件名字典序排列),但可以通过以下两种实用方法实现自定义排序,无需修改原示例文件名:
方法一:通过自定义组按注释顺序排序
创建一个专门用于控制顺序的头文件(比如examples_order.h),在其中按你想要的顺序编写每个示例的注释块,并将它们归入同一个组:
/** * @defgroup sorted_examples 按序排列的示例集合 * @{ */ /** * 初始化模块示例 * @example init_module.cpp * @ingroup sorted_examples */ /** * 数据处理核心示例 * @example data_process.cpp * @ingroup sorted_examples */ /** * 新添加的中间示例 * @example new_middle_case.cpp * @ingroup sorted_examples */ /** * 结果导出示例 * @example export_result.cpp * @ingroup sorted_examples */ /** @} */
Doxygen会按照这个头文件中注释块的出现顺序,在示例集合组内展示所有示例。插入新示例时,只需在对应位置添加新的注释块即可,完全不用改动原示例文件名。
方法二:手动创建自定义页面编排顺序
如果需要更灵活的展示形式,可以创建一个自定义页面,在其中按需求顺序逐个引用示例:
/** * @page custom_example_list 自定义顺序示例列表 * * 以下是按业务流程排序的示例: * 1. @ref init_module.cpp - 模块初始化 * 2. @ref new_middle_case.cpp - 新增业务逻辑示例 * 3. @ref data_process.cpp - 核心数据处理 * 4. @ref export_result.cpp - 结果导出 */
生成的文档中会出现这个自定义页面,用户可以通过页面内的链接直接跳转到对应示例的详情页。这种方式适合需要给示例添加额外说明、分组描述的场景。
内容的提问来源于stack exchange,提问作者Mikhail
相关产品推荐
相关产品推荐

