函數過載，文檔幾乎相同

Question

我有兩個acquire函數，除了它們的參數，文檔是相同的。我該如何處理？我是否應該添加類似於「在函數X的文檔中找到的相同的一般說明也適用於此處」？如果不是，Doxygen是否提供某種工具來處理這類情況？

ResourcePtr<T> acquire(const std::string& file); 
ResourcePtr<T> acquire(const void* buffer, std::size_t size); 

Answer 1

我不知道Doxygen，所以這個答案純粹是我的文檔方法。

當我在等，其中兩個主題幾乎相同的情況下記錄，我任一重複在兩個（優選的）的共享信息或我寫類似於以下東西：

「函數Y是類似於函數x 。函數Y採用參數abc和[放置它在這裏的工作方式] ...

有關這些函數的更多信息，請參見「。

在這種情況下，我會記錄更簡單的一個，並將更多信息添加到更復雜的信息。

第三種方法是從兩者中分離出共同的文檔，如果可能的話。

Answer 2

從This Page：

使用\ SA（另見）的關鍵字鏈接到相關的變量，方法或類。這是\ see標籤的等效命令。