c - 使用 doxygen 获取完成列表

Question

众所周知，如何在 Doxygen 中获取 TODO 列表，键入：

\todo Item one
\todo Item two

等等，但是当某事已经完成时，如何跟踪呢？

如果我已经完成了第二项，我不想删除它，我想将其标记为完成：

\todo Item ono
\done Item two

我该怎么做呢？

Answer 1

我翻遍了 Doxygen 文档并偶然发现了\xrefitem. 它应该是：

命令的概括，例如 \todo 和 \bug。它可用于创建用户定义的文本部分，这些文本部分会在发生位置和将生成的相关页面之间自动交叉引用。在相关页面上，将收集相同类型的所有部分。

第一个参数是唯一表示节类型的标识符。第二个参数是一个带引号的字符串，表示作为第四个参数传递的文本所在的部分的标题。第三个参数（列表标题）用作包含具有相同键的所有项目的相关页面的标题。“todo”、“test”、“bug”和“deprecated”键是预定义的。

所以你可以指定一个新的别名，例如"done"在你的 Doxyfile 中：

ALIASES += "done=\xrefitem done \"已实施的 TODOs\" \"已实施的 TODOs\" "

在您的代码中，您应该能够"done"像所有其他代码一样使用新标签：

/// \done 修复了损坏的函数

Answer 2

根据doxygen 手册\todo，该命令没有这样的“逆” 。也许您可以\todo以某种方式保留并手动将其标记为已完成。

不幸的是，doxygen 的 Markdown 似乎不支持删除线（显然，与 Stack Overflow 不同），否则这将是一个好的和常见的选择。也许您可以使用自定义样式和跨度进行设置。