vscode添加新建文件头部注释和函数注释

  •  新建文件作者注释和方法函数注释
  • 搜索添加koroFileHeader 插件,安装之后reload

  • ctrl+shift+p 搜索setting,然后搜索FileHeader点击并且进入setting界面(json界面亦可)

  • 右侧注释代码如下
//配置新建文件注释和方法注释
"fileheader.configObj": {
    "createFileTime": true,//设置为true则为文件新建时候作为date,否则注释生成时间为date
    "autoAdd": true,//自动生成注释,老是忘记的同学可以设置
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": true//设置自定义注释可用
    },
    "headInsertLine": {
      "php": 2
    }
  },
  "fileheader.cursorMode": {
    "description":"",
    "param ":"",
    "return":""
  },
  "fileheader.customMade": {
    "Description":"" ,//文件内容描述
    "Author":"huacong",//编辑人
    "Date": "Do not edit",//时间
    "LastEditTime": "Do not edit",
    "LastEditors": "huacong",
  }
  •  若没有设置自动生成注释
  1. 文件头部添加注释:快捷键:windowctrl+alt+i,macctrl+cmd+i

  2. 在光标处添加函数注释:快捷键:windowctrl+alt+t,macctrl+cmd+t(快捷键如果没有生效,注意简介快捷键是否被占用) 

 

 重启之后生效,如下

### 配置 VSCode 文件注释头部模板 为了在 Visual Studio Code (VSCode) 中自动添加文件的注释头部模板,可以利用 `koro1FileHeader` 插件来实现这一功能。通过编辑 `settings.json` 文件中的特定配置项,能够自定义每次创建新文件时所附带的信息。 #### 安装 koro1FileHeader 插件 确保已安装名为 `koro1FileHeader` 的插件[^1]。此操作可通过访问官方文档获取指导完成安装过程。 #### 编辑 settings.json 文件 打开全局或工作区级别的 `settings.json` 文件(可以通过命令面板输入 `Preferences: Open Settings (JSON)` 来快速定位)。在此 JSON 对象内加入以下字段用于定制化文件头: ```json { "fileheader.customMade": { "Description": "这里是文件描述", "Author": "作者姓名", "Date": "Do not edit", // 创建日期由插件管理 "LastEditTime": "Do not edit" // 上次编辑时间同样交予插件处理 }, "fileheader.cursorMode": { "description": "此处填写方法说明", "param": "参数列表", "return": "返回值" } } ``` 上述代码片段展示了如何指定文件级函数级的默认注释格式[^2]。对于 `"fileheader.customMade"` `"fileheader.cursorMode"` 下的各项属性,可以根据个人需求调整其初始值;而像 “Date” 或者 “LastEditTime”的具体数值则会依据实际情况动态生成,因此建议保持原样以便让插件自行维护这些信息。 另外,在某些情况下可能还需要考虑启用或禁用自动化行为,比如是否希望每当保存文件的时候都更新最后修改的时间戳等特性。这通常也是通过类似的设置选项来进行控制的。 #### 使用快捷键添加注释 除了预先设定好固定的模板外,还可以借助于预设好的快捷方式即时插入所需的注释结构。例如,在 Windows 平台上按下 `Ctrl + Alt + T` 即可在当前光标的所在位置触发一次新的函数注释插入动作[^4]。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值