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
*/

好像应该有这样的选项存在，但我无法在任何地方找到它。是否实际上有这个选项，或者我只需要在描述中做个记录？

- ewok

Answer 1

回答你的问题：没有这样的东西。

但是我不同意你认为应该有这样的东西。毕竟，函数声明将与其文档一起显示，因此每个人都可以看到b是可选的以及默认参数是什么。对于\fn，请参阅doxygen的文档，其中不鼓励使用\fn。

- Arne Mertz

---

很好了解。对于全局函数，我应该使用什么来替代\fn？ - ewok

什么都不用做 - 就像我发布的链接所说的那样（第一段），只需在函数（声明）之前添加文档注释即可。 - Arne Mertz

Answer 2

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

您可以添加任何选项！

- colin stevens

Answer 3

Doxygen并没有提供您需要的内容 - 您需要在描述中手动记录它。

- Mike Kwan