VsCode插件,自动生成注释koroFileHeader

最近正在使用vscode进行编程,为了更便利的对项目实施管理,同时利于后期维护,为一个版块添加注释是非常有必要的。实践出真知,以下是对于插件koroFileHeader的简单使用说明。

打开vscode,选择Extensions搜索koroFileheader进行安装

在这里插入图片描述

在vue文件中,使用快捷键ctrl + Alt + i/t,可以看到当前默认设置内容

在这里插入图片描述

根据需要修改默认设置

1.选择File-Preferences-Settings,搜索fileheader

在这里插入图片描述

2.修改默认设置

在这里插入图片描述

需要注意:下面这个界面,本身里面是没有红框中的内容的,需要自己添加。

在这里插入图片描述
最终修改版本:
在这里插入图片描述

代码:
"fileheader.customMade": {    //此为头部注释
        "Description": "",
        "Version": "2.0",
        "Autor": "Seven",
        "Date": "Do not edit",
        "LastEditors": "Seven",
        "LastEditTime": "Do not edit"
    }"fileheader.cursorMode": {  //此为函数注释
        "description":"",
        "param": "",
        "return": "",
        "author":"Seven"
    }
最终呈现效果;

在这里插入图片描述
在这里插入图片描述

注:

1.描述内容(descripition)为了便捷添加,直接设置为空;
2.这里的日期(Date)和修改时间(LastEditTime)设置,本身软件就会自行添加和更新,所以直接写“Do not edit”即可。
3.除日期和参数(param)外的其他内容,均可尝试设置为汉字,方便查看。

  • 20
    点赞
  • 58
    收藏
    觉得还不错? 一键收藏
  • 38
    评论
VSCode中,有多种插件可以帮助删除注释。其中一些常用的插件包括KoroFileHeader插件、Better Comment插件、CodeGeeX插件、GhostDoc插件、Doxygen Comments插件、Comment Divider插件和Comment Translate插件。\[1\] KoroFileHeader插件可以帮助你在代码文件中添加文件头注释,而Better Comment插件可以帮助你更好地阅读和管理注释。CodeGeeX插件是一个基于AI大模型的编程辅助工具,可以自动生成注释和翻译注释,支持多种编程语言。GhostDoc插件可以根据源代码生成XML注释,用于维护文档和生成帮助文档。Doxygen Comments插件可以自动创建Doxygen注释,用于生成代码文档。Comment Divider插件可以一键生成分隔线注释,而Comment Translate插件可以使用翻译API将VSCode的编程语言注释翻译成其他语言。\[2\]\[3\] 使用这些插件,你可以根据自己的需求选择合适的插件来删除注释。例如,你可以使用Better Comment插件来隐藏或标记注释,或者使用CodeGeeX插件自动生成注释并选择中英文注释。 #### 引用[.reference_title] - *1* *3* [【工具】vscode的常用插件注释插件](https://blog.csdn.net/qxhgd/article/details/130789475)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] - *2* [Vscode快速删除注释插件](https://blog.csdn.net/JCAnan/article/details/126462529)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 38
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值