我正在使用 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
*/
似乎这是应该存在的东西,但我一直无法在任何地方找到它。有实际的选择吗,还是我只需要在描述中注明?
回答你的问题:不,没有这样的事情。
但我不同意你认为应该有类似的东西的观点。毕竟,函数声明将与其文档一起显示,因此每个人都可以看到b
是可选的,它的默认参数是什么。而对于\fn
请参阅 doxygen 的文档不鼓励使用 \fn http://www.doxygen.nl/manual/commands.html#cmdfn.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)