C语言自动生成代码注释:koroFileHeader插件


以前写代码,只会用
//this is a add function
void add(int a,int b)
{
          
   
    return a+b;
}

因此找到了一个插件,可以在vscode上使用,名为 koroFileHeader 可以自动生成更美观的格式化注释

2.配置插件

快速上手步骤:

必须的基础配置: 头部注释模板与函数注释模板 复制:复制下面给出的模板 插入:插入模板到全局设置(setting.json)中。 简单的更改:比如把名字换成自己的,不需要的字段可以删掉。 重启编辑器,使用快捷键体验它。

如何找到setting.json设置模板 简单的输入命令 打开VSCode命令面板: mac: command + p window: ctrl + p 输入> Open Settings(注意>后面有一个空格) 输入后打开回车,会自动进入settings.json 把刚才复制的内容放到文件中

3.使用快捷键

在windows系统下, 快捷键被修改为 文件头注释为CTRL+WIN+I,在文件第一行空白处,输入快捷键,效果如下

函数注释为CTRL+WIN+T,在函数的上一行空白处,输入快捷键,效果如下

/**
 * @description: 
 * @param {char} *message
 * @return {*}
 */
void send_function(char *message);
经验分享 程序员 微信小程序 职场和发展