Documentation 在Doxygen中选择注意、注释、备注、待办事项和警告

文档生成器Doxygen允许将注释标记为注意，注释，备注，待办事项或警告

---

我应该遵循哪些准则来正确地将评论分类为其中之一？

所有这些标记都用于突出说明文档中特别值得注意的部分，与其他未标记的部分相比。它们都是用来吸引读者注意标记的段落

注释是最通用的标记，在大多数情况下，如果您希望读者“注意”本节中描述的事项，则可以使用该标记

Attention标记可用于突出显示一个特别重要的注释，这是您不希望读者忽略的注释

< >强>警告> /强>标签，当读者在使用所记录的项目时不小心时可能会产生负面后果。

备注和备注标记可用于重要性较低的备注。如果你想用“哦，顺便说一句”的方式来描述某件事，备注标签是很有用的

Todo标记的使用方式与您列出的其他标记不同。它通常用于表示注释中描述的代码有一个或多个未完成的方面。这会提醒代码用户和代码编写者需要在以后的相关代码部分修订中解决某个特性或错误。Doxygen有一个很酷的特性，它将在生成的输出中的自己部分中列出所有TODO。这可以通过编辑doxy文件并将行

GENERATE\u TODOLIST=YES

更改为

GENERATE\u TODOLIST=NO

来关闭

与Todo标记相关的是Bug标记，它可以专门用于标记描述软件Bug的文档。同样，Doxyfile有一行

GENERATE_BUGLIST=YES

导致所有bug都列在它们自己的部分中；这可以通过

GENERATE\u BUGLIST=NO

关闭