多行注释Doxygen @note？

Question

在非Doxygen注释中，我经常会写下如下内容：

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

然而使用Doxygen时，我有@note(或\note)，而不是@notes。所以，我应该使用多个@note还是将所有注释放在同一个@note下？

- einpoklum

Answer 1

@note命令会生成一个段落，其格式可以在CSS文件或使用Latex时的样式文件中进行自定义。因此，您可以像在“普通”文本中一样使用标记：

/**
 * 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.
 */

- gmug

Answer 2

您可以选择任意一种方式，这只是一个风格/偏好问题。

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

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

使用这个方法，你可以在文档中插入命令@notes，它会生成一个用户自定义段落，并带有标题：

注释：

正如在Doxygen ALIAS标签的文档中指出的那样，你可以在别名的值部分中放置\n来插入新行。

- sifferman

---

好的，虽然构建人员会抱怨我在琐事上浪费时间而不是做实际工作... - einpoklum

我对那个问题没有答案。 - sifferman