VSCode 添加自定义注释的方法(附带红色警戒经典注释风格)
如何设置一个自定义注释
整洁的代码和注释风格总是给人一种眼前一亮、赏心悦目的感觉,同时详细的注释也是程序员所必须的职业素养之一
今天主要分享一下如何在VSCode中设置自定义注释
第一步:
使用ctrl+shift+p调出如下窗口,并且输入snippets
第二步:进入json文件编辑
这里以自定义js注释为例:
"Printtojsclass":{ "prefix":"zhushiclass", "body":[ "/*", "*@Description:$0", "*@ClassAuthor:TianQin", "*@Date:${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}", "*/" ], }, "Printtojsmethod":{ "prefix":"zhushimethod", "body":[ "/*", "*@Description:$0", "*@MethodAuthor:HeLihui", "*@Date:${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}", "*/" ], },
第三步:
保存退出后,我们可以在js文件中看到智能提示
因为html注释格式为<--!-->
"Printtohtmlmethod":{ "prefix":"zhushihtml", "body":[ "" ], },
最后想分享一下红色警戒的源码注释的格式,在红色警戒的源码公开之后,他的注释简直堪称经典
我整理了一下这段注释,致敬经典!
"Printtojsapi":{ "prefix":"hongsejingjie", "body":[ "/***************************************************************************************************", "*AircraftClass::$0*", "*@Description:$0*", "*@Description:$0*", "*@Description:$0*", "**", "*INPUT:$0*", "**", "*OUTPUT:$0*", "**", "*WARNINGS:$0*", "*HISTORY:*", "*@MethodAuthor:HeLihui*", "*@Date:${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}${CURRENT_HOUR}*", "*==================================================================================================*/" ], },
由于这是我自己整理出来的,所以效果不是很好,所以大家请见谅,也希望大家能够继续完善
总结
到此这篇关于VSCode添加自定义注释(附带红色警戒经典注释风格)的文章就介绍到这了,更多相关VSCode添加自定义注释内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票!
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。