当然可以!这是一个标准的 C 语言接口注释的例子:
/**
* @brief 这是一个示例函数,它将两个整数相加
* @param x 第一个整数
* @param y 第二个整数
* @return x 和 y 的和
*/
int add(int x, int y) {
return x + y;
}
在这里,我们使用了三个注释标记:
@brief
:简要说明函数的作用。@param
:描述函数的参数。@return
:描述函数的返回值。
这些注释标记可以使用 Doxygen 等工具生成函数文档。
注意,注释是用 /**