VsCode自动生成注释

最新推荐文章于 2024-07-12 11:01:09 发布

兔子零-A酱

最新推荐文章于 2024-07-12 11:01:09 发布

阅读量1.3w

点赞数 5

分类专栏：前端

本文链接：https://blog.csdn.net/weixin_43764814/article/details/104883558

版权

本文介绍了如何在Visual Studio Code中安装和配置插件，以实现文件头部和函数的自动注释生成。通过设定快捷键，用户可以使用Ctrl+Alt+i (Windows) 或 Ctrl+Cmd+i (Mac) 创建文件头部注释，而Ctrl+Alt+t (Windows) 或 Ctrl+Cmd+t (Mac) 则用于生成函数注释。

摘要由CSDN通过智能技术生成

第一步安装插件:KoroFileHeader
第二步在setting.json中配置

快捷键:
文件头部注释：
- 在当前编辑文件中使用快捷键:window：ctrl+alt+i/mac：ctrl+cmd+i,即可生成文件头部注释。
函数注释：
- 将光标放在函数行或者将光标放在函数上方的空白行
- 使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释。
- 事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

核心代码:

 "fileheader.customMade": {
       //此为头部注释
    "Description": "",
    "Version": "2.0",
    "Autor": "wangmiao",
    "Date": "Do not edit",
    "LastEditors": "wangmiao",
    "LastEditTime": "Do not edit"
  },
  "fileheader.cursorMode": {
     //此为函数注释
    "description":"",
    "param": "",
    "return": "",
    "author":"wangmiao"
  }

效果:
在这里插入图片描述

{
   
  // 換行
  "editor.wordWrap": "on",
  // 是否允许自定义的snippet片段提示
  "editor.snippetSuggestions": "top",
  // vscode默认启用了根据文件类型自动设置tabsize的选项 不檢查縮進，保存后統一按設置項來設置
  "editor.detectIndentation": false,
  // 重新设定tabsize 代码缩进修改成4个空格
  "editor.tabSize": 2,
  // #每次保存的时候自动格式化
  "editor.formatOnSave": false,
  // #每次保存的时候将代码按eslint格式进行修复 使用eslint 風格使用standard 進行代碼規則限制
  "editor.fontWeight": "200",
  "editor.formatOnType": false,
  "workbench.iconTheme": "vscode-icons-mac",
  "git.confirmSync": false,
  "team.showWelcomeMessage": false,
  "window.zoomLevel": 0,
  "editor.renderWhitespace": &