在Doxygen中选择注意,注释,注释,待办事项和警告

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

我应该遵循哪些指导方针才能将评论正确归类为其中之一？

与未标记的其他部分相比,所有这些标记用于突出显示文档的一部分特别值得注意的目的.它们都用于吸引读者注意标记的段落.

该注意是最通用的标签,并在您希望读者在部分说明的情况"采取通知"大多数情况下使用的.

该注意标签可以用来突出一个特别重要的注意事项,一个你不希望读者忽略.

该警告标签应该被用来代替时注意可能会有负面影响考虑,如果读者不在于他如何使用被记录的项目小心.

该备注和说明标签可用于具有不太重要的笔记.如果你想在"哦,顺便说一句"的意义上描述一些东西,那么Remark标签对此很有用.

该待办事项标记用于不同于你列出的其他人.它通常用于表示注释中描述的代码具有一个或多个未完成的方面.这会向代码用户和代码编写者发出警告,需要在相关代码段的后续版本中解决功能或错误.Doxygen有一个很酷的功能,它会在生成的输出中将所有Todos列在他们自己的部分中.可以通过编辑Doxyfile并将行更改为GENERATE_TODOLIST = YES来关闭它GENERATE_TODOLIST = NO.

与Todo标记相关的是Bug标记,可以专门用于标记描述软件错误的文档.同样,Doxyfile有GENERATE_BUGLIST = YES一行可以使所有的Bugs列在自己的部分中; 这可以关闭GENERATE_BUGLIST = NO.