OBKoro1 / koro1FileHeader

VSCode插件:自动生成,自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数,支持所有主流语言,文档齐全,使用简单,配置灵活方便,持续维护多年。
MIT License
5.66k stars 274 forks source link

流程弄简单一点! #360

Closed www516717402 closed 3 years ago

www516717402 commented 3 years ago

我仅仅需要一个健全、好看的注释而已,建议给几套模板,大家直接复制黏贴使用就行了。关于那些字段等乱七八糟的东西,感兴趣的人去看即可。

www516717402 commented 3 years ago

遇到一个bug

  1. python环境
  2. 直接使用注释+前注释没问题,前注释意思是地址
  3. 使用注释+前注释+design,会导致前注释消失
CourageAndDesire commented 3 years ago

我仅仅需要一个健全、好看的注释而已,建议给几套模板,大家直接复制黏贴使用就行了。关于那些字段等乱七八糟的东西,感兴趣的人去看即可。

可以直接复制 配置字段部分可以实现。我就是这么干的。至于其他的具体的功能,需要的时候再去查询使用方法就行。

www516717402 commented 3 years ago

我仅仅需要一个健全、好看的注释而已,建议给几套模板,大家直接复制黏贴使用就行了。关于那些字段等乱七八糟的东西,感兴趣的人去看即可。

可以直接复制 配置字段部分可以实现。我就是这么干的。至于其他的具体的功能,需要的时候再去查询使用方法就行。

今天尝试把koro配置直接复制进snnipets里面,真的是又快有好用:

{
    "HEADER": {
      "prefix": "header",  # python文件里面快捷命令
      "body": [
        "#!/usr/bin/env python",
        "# -*- encoding: utf-8 -*-",
        "'''  # *************&&******************$$*************==***************** #",
        " ^+_+^ @ ┌─────────────────────────────────────────────────────────────┐",
        " ^+_+^ @ │┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐│",
        " ^+_+^ @ ││Esc│!1 │@2 │#3 │^4 │%5 │^6 │&7 │*8 │(9 │)0 │_- │+= │| '│'~ ┤│",
        " ^+_+^ @ │├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤│",
        " ^+_+^ @ ││ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │{[ │}] │ BS  ││",
        " ^+_+^ @ │├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤│",
        " ^+_+^ @ ││ Ctrl │ A │ S │ D │ F │ G │ H │ J │ K │ L │: ;│' '│ Enter  ││",
        " ^+_+^ @ │├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┤│",
        " ^+_+^ @ ││ Shift  │ Z │ X │ C │ V │ B │ N │ M │< ,│> .│? /│Shift │Fn ││",
        " ^+_+^ @ │└─────┬──┴┬──┴──┬┴───┴───┴───┴───┴───┴──┬┴───┴┬──┴┬─────┴───┘│",
        " ^+_+^ @ │      │Fn │ Alt │         Space         │ Alt │Win│   HHKB   │",
        " ^+_+^ @ │      └───┴─────┴───────────────────────┴─────┴───┘          │",
        " ^+_+^ @ └─────────────────────────────────────────────────────────────┘",
        " ^+_+^ @FileName: $TM_FILENAME",
        " ^+_+^ @Author: XXX",
        " ^+_+^ @Email: XXX.com",
        " ^+_+^ @Description: None",
        " ^+_+^",
        " ^+_+^ @BuildDate: $CURRENT_YEAR/$CURRENT_MONTH/$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
        " ^+_+^ @LastEditors: XXX",
        " ^+_+^ @Copyright: XXX Co., Ltd. All rights reserved.",
        " ^+_+^ @Version: V0.01",
        " ^+_+^ @ChangeLog: None",
        " ^+_+^",
        "'''  # *************&&******************$$*************==***************** #",
        "",
        "$0"
      ],
    }
  }
# koro使用图案之后无法显示前缀(可能是bug),这里完全没有这个问题
# koro图案有点pep8检查警告,这里已经修改
# 其它语言使用直接创建其它语言配置即可

#!/usr/bin/env python
# -*- encoding: utf-8 -*-
'''  # *************&&******************$$*************==***************** #
 ^+_+^ @ ┌─────────────────────────────────────────────────────────────┐
 ^+_+^ @ │┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐│
 ^+_+^ @ ││Esc│!1 │@2 │#3 │^4 │%5 │^6 │&7 │*8 │(9 │)0 │_- │+= │| '│'~ ┤│
 ^+_+^ @ │├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┤│
 ^+_+^ @ ││ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │{[ │}] │ BS  ││
 ^+_+^ @ │├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤│
 ^+_+^ @ ││ Ctrl │ A │ S │ D │ F │ G │ H │ J │ K │ L │: ;│' '│ Enter  ││
 ^+_+^ @ │├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬───┤│
 ^+_+^ @ ││ Shift  │ Z │ X │ C │ V │ B │ N │ M │< ,│> .│? /│Shift │Fn ││
 ^+_+^ @ │└─────┬──┴┬──┴──┬┴───┴───┴───┴───┴───┴──┬┴───┴┬──┴┬─────┴───┘│
 ^+_+^ @ │      │Fn │ Alt │         Space         │ Alt │Win│   HHKB   │
 ^+_+^ @ │      └───┴─────┴───────────────────────┴─────┴───┘          │
 ^+_+^ @ └─────────────────────────────────────────────────────────────┘
 ^+_+^ @FileName: convert_mxrecord.py  # 这里会自动生成文件名
 ^+_+^ @Author: XXX
 ^+_+^ @Email: XXX.com
 ^+_+^ @Description: None
 ^+_+^
 ^+_+^ @BuildDate: 2021/08/27 17:40:27  # 自动生成时间
 ^+_+^ @LastEditors: XXX
 ^+_+^ @Copyright: XXX Co., Ltd. All rights reserved.
 ^+_+^ @Version: V0.01
 ^+_+^ @ChangeLog: None
 ^+_+^
'''  # *************&&******************$$*************==***************** #