【发布时间】:2019-03-29 16:38:56
【问题描述】:
用doxygen,我习惯了写
/**
* @brief blah blah
*
* @param foo description of foo
* @param bar description of bar
* @return description of the return value
*/
int f(int foo, unsigned bar);
但是如果我没有指定参数之一怎么办? :
int f(int, unsigned bar);
当我无法通过名称引用此参数时,如何记录该参数?
【问题讨论】:
-
据我所知,除了提供文字参考之外,这是不可能的。在定义/原型中有名称的反对意见是什么?
-
@albert:当您不使用该参数时,(有点)习惯不使用它。
-
是的,我知道,但是为什么首先要有论点(历史/兼容性是一个很好的理由)。记录未使用的参数的原因是什么?
-
@albert:理解为什么这个函数被一个额外的所谓无用参数调用可能很重要,例如(在类似调用的其他函数中,this 用于 XYZ,但在此函数中不是因为原因。”
-
我认为在这种情况下,它也应该是“XYZ”(或“dummy_xyz”),并且描述应该解释它为什么存在。
标签: documentation doxygen