多子弹Doxygen @note？

Question

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

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

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

Answer 1

@note命令会生成一个段落，使用Latex时可以在CSS文件或样式文件中自定义该格式。所以你可以使用像＃＆＃34; normal＆＃34;中的标记。文本：

/**
 * Bla bla...
 *
 * @note Even in a note you can use markups:
 *       - Your first note
 *       - Youre second note
 *
 * The note section ends with an empty line or the end of the comment.
 */

Answer 2

你可以这样做;这真的是一种风格/偏好的问题。

正如您所指出的，Doxygen具有@note命令，但不是@notes。您可以通过编辑Doxyfile并将@notes标记修改为

来为ALIASES =创建自己的命令

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

有了这个，您可以将命令@notes放在文档中，这将导致用户定义的段落标题为

  

备注：

正如Doxygen documentation for the ALIAS tag中所指出的，您可以将\ n设置在别名的值部分以插入换行符。