Doxygen - 声明参数为可选参数

Posted 2021-05-04

我正在使用Doxygen记录代码库，并且想知道是否有一个关键字用于声明函数的参数是可选的。就像是：

/*!
fn int add(int a, int b=0)
rief adds two values
param a the first operand
param optional b the second operand.  Default is 0

eturn the result
*/

看起来这应该存在，但我无法在任何地方找到它。是否有实际选项，或者我只需要在说明中做出注释？

答案

回答你的问题：不，没有这样的事情。

但我不同意你应该有类似的观点。毕竟，函数声明将与其文档一起显示，因此每个人都可以看到b是可选的，它的默认参数是什么。而对于fn，请参阅doxygen的文档discouraging the use of fn。

另一答案

Doxygen不提供您想要的内容 - 您必须在说明中手动记录它。