c++ - Doxygen - 将参数声明为可选

Question

我正在使用 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
*/

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

Answer 1

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

但我不同意你的观点，即应该有这样的事情。毕竟，函数声明会连同它的文档一起显示，所以每个人都可以看到它b是可选的，它的默认参数是什么。并且\fn请参阅 doxygen 的文档，不鼓励使用 \fn。

Answer 2

Doxygen 不提供您想要的东西 - 您必须在描述中手动记下它。

Answer 3

我作弊并使用 \param foo [in,out,opt,banana] 描述 foo 的用途。

您可以添加任何选项！