Doxygen Comment Tags 编程辅助工具注释标记 @brief @param @return

发布时间 2023-05-28 23:35:37作者: 第一方登录

以@brief @param @return 等形式出现的注释标记被称为Doxygen注释标记(Doxygen Comment Tags)或者简称为Doxygen标记。

这玩意常用来作为接口文档说明或者接口源码注释,又比如EmmyLua用这个来作为lua函数的注释以提供智能提示。

常见的doxygen注释标记及其作用:

/**
 * @biref 简介
 * @prarm paramName 函数形参介绍
 * @return returnType 函数返回值类型说明
 * @exception 可能抛出的异常
 * @author 作者
 * @data 时间
 * version 版本
 * property 属性介绍
 */