多子弹 Doxygen @note？

Question

在非 Doxygen 的评论中，我经常有：

/* Lorem ipsum etc.
 *
 * Notes:
 * - A first note.
 * - Some other note note.
 */

但是对于 Doxygen，我有@note（或\note），没有@notes）。那么，我应该使用多个@notes，还是将所有注释都放在同一个 s 下@note？

Answer 1

两种方法都可以；这确实是风格/偏好的问题。

正如您所指出的，Doxygen 有命令@note，但没有@notes。@notes您可以通过编辑 Doxyfile 并修改ALIASES =标签来创建自己的命令

ALIASES = "notes=@par Notes:\n"

这样，您可以将命令放入@notes文档中，这将生成一个用户定义的段落，其标题为

笔记：

正如ALIAS 标记的 Doxygen 文档中所指出的，您可以将 \n 放在别名的值部分中以插入换行符。