記錄Boost.Test測試用例

有沒有任何方法可以對使用Boost.Test宏定義的測試用例使用文檔註釋？我可以使用Doxygen風格的評論，他們會被正確解析？記錄Boost.Test測試用例

2012-03-12 Marc Andreson

根據doxygen [預處理文檔]（http://www.stack.nl/~dimitri/doxygen/preprocessing.html），應該可以用普通的doxygen樣式註釋來記錄這些測試，但您可能必須花費一點時間在配置文件中使用'predefined'標誌。在[this]（http://www.stack.nl/~dimitri/doxygen/preprocessing.html）頁面的一半處查看'IUnknown'類示例。 – Chris 2012-03-13 08:17:11

答案是讓你的測試用例如此簡單，明顯，可讀性強，以至於你寫的任何文檔都是多餘的。請參閱我的rewrite of the Boost.Test docs中標題爲Test Case Maintenance and Design的部分。

來源

2014-08-08 20:21:15 legalize

是的，這當然不用說了，但我認爲在測試中有一個附加到該類的所有測試用例的列表是很好的，所以文檔顯示了這個和測試的內容。 – Rene 2015-10-27 16:38:33

這增加了一個額外的維護負擔，這是不合理的IMO。實際的評論已經與代碼不同。軟件工程的趨勢一直是[直接在代碼中表達思想]（https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-direct），而不是依靠評論或其他元數據碼。 – legalize 2015-10-27 20:37:43

記錄Boost.Test測試用例

回答

相關問題