@brief: 这个标签后面跟着的是函数的简短描述,通常是一句话或一个简短的语句,用来概括函数的主要作用。
@param: 此标签用于描述函数的参数,每个参数都会有一个@param标签,后面跟着参数名和对该参数的详细描述,包括数据类型、含义、取值范围等。
@note: @note标签用于提供额外的注意点或者重要的信息,这些信息可能对于正确使用函数非常关键,比如某些条件下的行为、限制或推荐的使用方式。
除了上述三个常见的标签,还有其他一些可能出现在函数文档中的标签:
@retval: 描述函数的返回值,包括可能的返回值类型和意义。
@return: 也用于描述返回值,但使用@return时通常不包含类型信息。
@warning: 标记潜在的问题或陷阱,提醒用户在使用函数时要注意的地方。
@attention: 类似于@warning,强调特别需要注意的事项。
@ingroup: 指出这个函数属于哪个函数组或模块,有助于分类和查找相关函数。

540

被折叠的 条评论
为什么被折叠?



