如何让Doxygen在穿插代码场景下保持有序列表连续编号
Doxygen穿插代码块时有序列表连续计数的解决方法
Doxygen默认将被非注释代码块分隔的两个有序列表判定为独立列表,编号会自动重置,可通过以下几种方法解决:
- 方案1:使用
\startlist+\endlist显式标记列表范围
这是兼容性最好的方案,适合列表跨度较长的场景,给列表指定自定义标识符关联起止范围即可,修改后的代码示例如下:
void function(void) { int a = 3; //! \startlist op_steps //! -# if a is 3, do the following: if(a == 3) { //! - Do magic math with a; a = a * 23; } //! -# if b is 3, do the following: if(b == 3) { //! - Do magic math with b; b = b * 23; } //! \endlist op_steps }
其中op_steps为自定义的列表ID,Doxygen会将该起止标记内所有-#开头的条目归为同一个有序列表,自动连续编号。
- 方案2:使用续号标记快速续接(适配Doxygen 1.8.10及以上版本)
无需包裹整个列表,只需要在需要续接编号的有序列表项的标记后加<即可,写法更简洁:
void function(void) { int a = 3; //! -# if a is 3, do the following: if(a == 3) { //! - Do magic math with a; a = a * 23; } //! -#< if b is 3, do the following: if(b == 3) { //! - Do magic math with b; b = b * 23; } }
-#<会主动告知Doxygen本条有序列表项续接前面最近一个有序列表的编号,无需额外标记。
- 方案3:手动调整列表计数器
如果需要自定义起始编号,也可以通过\setcounter命令手动指定下一个有序列表项的起始值:
//! \setcounter{enumi}{1} //! -# if b is 3, do the following:
计数器enumi的数值为上一个列表项的编号值,比如上一个列表项编号是1,这里填1,下一个项就会从2开始计数。
内容的提问来源于stack exchange,提问作者George Wu
相关产品推荐
相关产品推荐

