如何在别的电脑上操作,在函数前一行输入/** + 回车,就会出现带有格式的注释？

Question

Vscode 在函数前面添加说明注释,编写的C语言

示例:

void key_task(void *arg)
{}

在别的电脑上操作,在函数前一行输入/** + 回车,就会出现带有格式的注释

/**
 * @brief 按键读取任务
 *
 * @param arg
 */
void key_task(void *arg)
{}

---

在我的电脑上操作,结果如下,并没有出现@brief , @param arg 这些字样

/**
 * 
*/
void key_task(void *arg)
{}

是我的Vscode的什么地方没有设置好吗?

Answer 1

该回答引用ChatGPT
需要在 VS Code 中启用相应的扩展，以支持函数注释的自动补全和格式化。

常用的 C/C++ 注释扩展有两种，一种是 Doxygen，另一种是 Javadoc。两种扩展都支持类似于 @brief 和 @param 的标签，以及函数参数和返回值的类型、名称等信息。

以下是在 VS Code 中启用 Doxygen 注释的方法：

1、打开 VS Code 编辑器，进入扩展商店。

2、搜索并安装 “C/C++ Doxygen Comments” 扩展，等待安装完成并重新启动 VS Code。

3、在需要添加注释的函数上方输入 /** 后按回车键，即可自动添加 Doxygen 格式的注释。如果不需要某些标签，可以直接删除相应行即可