我的 C++ 代码中有 typedef 结构。截至目前,它们被列为\var
类型定义。有一个更好的方法吗?下面是我所拥有的示例:
/*! \var typedef etc
* \brief A type defined structure for etc
*
* \param x type- Variable declaration for x
* \param y type- Variable declaration for y
*/
我知道我什至不应该说param
。还有什么可以用的?
如果将注释块放在 typedef 前面,则不需要使用任何特殊命令。
/** This is the documentation for the following typedef */
typedef MyClass MyTypedef;
如果您喜欢将其放在 typedef 之后,请使用以下命令:
typedef MyClass MyTypedef;
/**< This is the documentation for the preceding typedef */
仅当注释块必须位于与实际 typedef 不同的位置时,才需要使用 \typedef。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)