Doxygen - 将参数声明为可选答案

【问题标题】：Doxygen - declare parameter as optionalDoxygen - 将参数声明为可选
【发布时间】：2012-12-25 00:43:21
【问题描述】：

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

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

似乎这是应该存在的东西，但我无法在任何地方找到它。有没有实际的选择，还是我只需要在说明中做说明？

【问题讨论】：

标签： c++ parameters doxygen optional-parameters

【解决方案1】：

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

但我不同意你的观点，即应该有这样的东西。毕竟函数声明会和它的文档一起显示，所以大家可以看到b是可选的，它的默认参数是什么。对于\fn，请参阅 doxygen 的文档discouraging the use of \fn。

【讨论】：

很高兴知道。对于全局函数，我应该使用什么来代替 \fn？
什么都没有——只需将文档注释放在函数之前（-declaration），就像我发布的链接所说的（第一段）

【解决方案2】：

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

【讨论】：

【解决方案3】：

我作弊并使用\param foo [in,out,opt,banana] Describe what foo is for.

您可以添加任何个选项！

【讨论】：