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

2021-11-30 23:27:27 +08:00
 techstay

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

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

koroFileHeader

非常的花里胡哨
BeautifulSoap
2021-12-01 00:58:52 +08:00
@vanton 这个插件除了生成佛祖,还能生成耶稣,真主吗.jpg
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

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

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

/*
* 注释
*/
techstay
2021-12-01 02:22:52 +08:00
@vanton 这个有点意思,冲这个神兽图案我就得装上,不过看了一下主要是添加文件头和函数头的注释,现在我还用不上。我想要的其实是类似[Comment Divider]( https://marketplace.visualstudio.com/items?itemName=stackbreak.comment-divider)这种功能,不过这个插件做的又有点太简单了,如果能把这俩结合一下就好了
alanleung410
2021-12-01 09:44:50 +08:00
我想找个参数自动注解的插件( Annotation ),vscode 用的
yangzzzzzz
2021-12-01 10:26:40 +08:00
/**
* @Author yourName
* @Description 自己设置一个模板呗。
* @Date 2021-12-01 10:26:13 星期三
*/
james2013
2021-12-01 21:15:40 +08:00
JetBrains 全家桶可以设置模版,然后输入指定的字符串就出来了

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/819160

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX