我想在我的代码中使用氧注释来创建项目符号列表,以补充生成文档中的函数描述。例如,以下代码片段:
/**
* Function x
*/
void function (void) {
/// List:
/// - comment A
;
;
/// + comment B
;
;
/// * comment C
}
应该生成这样一个列表:
List:
- A
- B
- C
不幸的是,氧似乎没有保持从一个注释块到另一个注释块的缩进水平。有解决方法吗?
谢谢
经过过去几个小时的研究,我得出的结论是,在不连续的氧原子注释之间缩进列表是不可能的。
我可以让缩进列表很容易地在块注释中工作:
/**
-# Item 1
-# Subitem 1
-# Subitem 2
-# Item 2
*/
切换到单行注释,仍然有效:
/// -# Item 1
/// -# Subitem 1
/// -# Subitem 2
/// -# Item 2
当我在单行注释之间添加代码时,氧原子停止缩进子条目。
实际上可以使用HTML格式
//! <ul><li> Entering a condition:<ul>
if (xx)
{
//! <li> something
C=A+B;
//! <li> something else
D="lol";
}
//! </ul></ul>