使用doxygen獲取完成列表

Question

眾所周知如何在Doxygen中輸入TODO列表，輸入：

\todo Item one
\todo Item two

等等，但是當做完某件事后，如何跟蹤呢？

如果我已經完成了第二項，我不想刪除它，我想將其標記為完成：

\todo Item ono
\done Item two

我該怎么做呢？

Answer 1

我\\xrefitem了Doxygen文檔，偶然發現了\\xrefitem 。 應該是：

命令的一般化，例如\\ todo和\\ bug。 它可用於創建用戶定義的文本部分，這些文本部分將在出現位置和將要生成的相關頁面之間自動交叉引用。 在相關頁面上，將收集相同類型的所有部分。

第一個參數是唯一表示節類型的標識符。 第二個參數是一個帶引號的字符串，表示將第四個參數傳遞的文本放在其下的部分的標題。 第三個參數（列表標題）用作包含所有具有相同鍵的項的相關頁面的標題。 按鍵“ todo”，“ test”，“ bug”和“已棄用”是預定義的。

因此，您可以在Doxyfile中指定一個新別名，例如"done" ：

別名+ =“ done = \\ xrefitem完成\\”已實施的待辦事項\\“ \\”已實施的待辦事項\\“”

並且在您的代碼中，您應該能夠像其他所有代碼一樣使用新的"done"標記：

/// \\ done修復損壞的函數

Answer 2

根據doxygen手冊 ， \\todo命令沒有這樣的“反函數”。 也許您可以保留\\todo並以某種方式手動將其標記為完成。

不幸的是，doxygen的Markdown似乎不支持刪除線 （顯然不同於Stack Overflow的刪除線 ），否則，這將是一個不錯的普通選擇。 也許您可以使用自定義樣式和跨度對其進行設置。