V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
techstay
V2EX  ›  程序员

请问一下如何优雅的输入注释

  •  
  •   techstay ·
    techstay · 2021-11-30 23:27:27 +08:00 · 2097 次点击
    这是一个创建于 1121 天前的主题,其中的信息可能已经有所发展或是发生改变。

    就比如很多配置文件里面的注释大段,我借用的时候都是直接复制粘贴,感觉好 low 了,有没有什么比较优雅的办法呢。那些作者在要写这种注释的时候是怎么处理的呢?如果有个类似ascii art generator这样的东西就好了。

    # -----------------------
    # 这是注释
    # ------------------------
    
    13 条回复    2021-12-01 21:15:40 +08:00
    Bijiabo
        1
    Bijiabo  
       2021-11-30 23:35:44 +08:00
    我用的是 Monodraw ,价格不贵,感觉不错
    eason1874
        2
    eason1874  
       2021-12-01 00:42:13 +08:00
    我用 VS CODE ,写好函数,输入 /** 换行它就自动帮我提供注释模板了
    vanton
        3
    vanton  
       2021-12-01 00:55:37 +08:00
    如果是 vs code ,需要一个花里胡哨的注释生成工具,可以用下这个:
    https://marketplace.visualstudio.com/items?itemName=OBKoro1.korofileheader

    koroFileHeader

    非常的花里胡哨
    BeautifulSoap
        4
    BeautifulSoap  
       2021-12-01 00:58:52 +08:00 via Android
    @vanton 这个插件除了生成佛祖,还能生成耶稣,真主吗.jpg
    vanton
        5
    vanton  
       2021-12-01 01:12:40 +08:00
    @BeautifulSoap #4

    还能生成龙、羊驼、键盘、美女什么的。

    生成图案快捷键 window:ctrl+alt+j, mac:ctrl+cmd+j

    生成头部注释 window:ctrl+alt+i, mac:ctrl+cmd+i

    当前段注释 window:ctrl+alt+t, mac:ctrl+cmd+t

    用下来还算好用
    secondwtq
        7
    secondwtq  
       2021-12-01 01:52:59 +08:00
    感觉这种注释太花,也就文件头 license 声明有点用,其他地方用处不大。

    单行最大长度限制之类的倒是很常见,还见过有的要求在没行注释之前加 * 之类的符号的(常见于 C99 之前的 C 项目 ...),这种一个 formatter 基本搞定
    hibian
        8
    hibian  
       2021-12-01 01:53:30 +08:00 via iPhone
    设置个模版
    codingBug
        9
    codingBug  
       2021-12-01 02:00:01 +08:00 via Android
    ∥ 注释

    /*
    * 注释
    */
    techstay
        10
    techstay  
    OP
       2021-12-01 02:22:52 +08:00
    @vanton 这个有点意思,冲这个神兽图案我就得装上,不过看了一下主要是添加文件头和函数头的注释,现在我还用不上。我想要的其实是类似[Comment Divider]( https://marketplace.visualstudio.com/items?itemName=stackbreak.comment-divider)这种功能,不过这个插件做的又有点太简单了,如果能把这俩结合一下就好了
    alanleung410
        11
    alanleung410  
       2021-12-01 09:44:50 +08:00
    我想找个参数自动注解的插件( Annotation ),vscode 用的
    yangzzzzzz
        12
    yangzzzzzz  
       2021-12-01 10:26:40 +08:00
    /**
    * @Author yourName
    * @Description 自己设置一个模板呗。
    * @Date 2021-12-01 10:26:13 星期三
    */
    james2013
        13
    james2013  
       2021-12-01 21:15:40 +08:00
    JetBrains 全家桶可以设置模版,然后输入指定的字符串就出来了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5948 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 02:30 · PVG 10:30 · LAX 18:30 · JFK 21:30
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.