功能过载,文档几乎完全相同

时间:2011-06-10 05:33:48

标签: documentation doxygen

我有两个acquire函数,除了它们的参数外,文档是相同的。我该怎么处理?我应该添加类似“在功能X的文档中找到的相同的一般注释也适用于此处”吗?如果没有,Doxygen是否提供某种工具来处理这样的案件?

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

2 个答案:

答案 0 :(得分:1)

我不知道Doxygen,所以这个答案完全取决于我的文档方法。

当我在两个主题几乎相同的情况下进行文档记录时,我要么重复两者中的共享信息(首选),要么写下类似于以下内容的内容:

“函数Y类似于函数X.函数Y接受参数abc和[在这里以不同的方式工作] ...

有关这些功能的更多信息,请参阅。“

在这种情况下,我会记录更简单的一个,并将更多信息添加到更复杂的信息中。

如果可能的话,第三种方法是从两者中打破共同文档。

答案 1 :(得分:0)

来自This Page

使用\ sa(另请参阅)关键字链接到相关变量,方法或类。这是\ see标签的等效命令。