vscode种如何快速生成代码注释---->如何更优雅地写代码

File→Perference→Configure User Snippets:

在这里插入图片描述

我们找到一个叫python.json的文件,并打开,添加如下代码片:

{
	"HEADER": { "prefix" :"header",
"body" :[
        "#!/usr/bin/env python",
        "# -*- encoding: utf-8 -*-",
        "'''",
        "@filename     : $TM_FILENAME",
        "@description     :    ",
        "@time     : $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE/$CURRENT_HOUR",
        "@author     : Jane",
        "@Version     : 1.0",
        "'''",
        "",
        "$0"
    ],
},
"FUNCTION_DOC": { "prefix": "function",
"body": [
    "\"\"\"",
    "${1:[summary]}",
    "",
    ":param ${2:param}: ${3:[description]}",
    ":type ${2:param}: ${4:[type]}",
    ":return: ${5:[description]}",
    ":rtype: ${6:[type]}",
    "\"\"\""
],
"description": "Generate a Python docstring"
}

}

保存后,每次写代码时,在开头键入header并回车,就能看到开头部分的注释已经添加上去:

在这里插入图片描述

在函数种键入function并回车,就能看到函数部分的注释也被快速添加:

在这里插入图片描述

代码写起来,更加优雅了,方便自己下次查看时能快速回忆!

  • 3
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值