本文主要介绍在VSCode中添加自定义注释的方法(带红警经典注释风格)。这篇文章很详细,对你的学习或者工作有一定的参考价值。有需要的朋友可以参考一下。
如何设置一个自定义注释
整洁的代码和注释风格总是给人眼前一亮、赏心悦目的感觉,而详细的注释也是程序员必备的职业素养之一。
今天主要分享如何在VS代码中设置自定义注释。
第一步:
使用
ctrl + shift + p
调出以下窗口并输入片段。第二步:进入json文件编辑
下面是一个自定义js注释的例子:
进入json文件后,添加以下代码,可以自定义设计,保存并退出me。这里有一个类注释和一个方法注释。
“打印到js类”:{
前缀:诸是类,
body: [
/*,
*@Description: $0 ,
*@ClassAuthor:田勤,
* @ Date:$ {当前年}-$ {当前月}-$ {当前日期} $ {当前小时}:$ {当前分钟}:$ {当前秒} ,
*/
],
},
“打印到js方法”:{
前缀: zhushimethod ,
body: [
/*,
*@Description: $0 ,
*@MethodAuthor:鹤立辉,
* @ Date:$ {当前年}-$ {当前月}-$ {当前日期} $ {当前小时}:$ {当前分钟}:$ {当前秒} ,
*/
],
},
第三步:
保存后,我们可以在js文件中看到智能提示。
点击后会自动生成评论,自动生成日期。
注意,
这里html注释稍有不同
因为html注释格式是-!- -
打印到html方法:
前缀: zhushihtml ,
body: [
!- ,
* * @描述:$0 ,
-
],
},
最后,我想分享一下红警的源代码注释的格式。红警的源代码公开后,他的注释堪称经典。
我整理了这篇笔记,向经典致敬!
打印到js api :
前缀:红色境界,
body: [
/***************************************************************************************************,
* AircraftClass : $0 * ,
* @Description: $0 * ,
* @Description: $0 * ,
* @Description: $0 * ,
* *,
*输入:$0 * ,
* *,
*输出:$0 * ,
* *,
*警告:$0 * ,
*历史:* ,
* @MethodAuthor:鹤立辉* ,
* @ Date:$ {当前年}-$ {当前月}-$ {当前日期} $ {当前小时} *,
*==================================================================================================*/
],
},
由于是我自己整理的,效果不是很好,所以请见谅,希望你能继续完善。
总结
关于向VSCode添加自定义注释的这篇文章就到此为止(带有红色警报经典注释风格)。有关向VSCode添加自定义注释的更多相关内容,请搜索我们以前的文章或继续浏览下面的相关文章。希望大家以后能多多支持我们!