如何设置一个自定义注释
整洁的代码和注释风格总是给人一种眼前一亮、赏心悦目的感觉,同时详细的注释也是程序员所必须的职业素养之一
今天主要分享一下如何在VS Code中设置自定义 注释
第一步:
使用ctrl + shift + p 调出如下窗口,并且输入snippets
第二步:进入json文件编辑
这里以自定义js注释为例:
进入到 json 文件中后,添加如下代码,大家可以自定义设计,保存退出 我这里是一个类注释 一个方法注释
"Print to js method": {
"prefix": "csj",
"body": [
"/*",
" * @description",
" * @author cuishoujia ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}:${CURRENT_SECOND}",
" * @param {Object}",
" * @return {Object}",
"*/"
],
}
- 保存退出后,我们可以在js文件中看到智能提示
点击之后会自动生成注释 ,同时date会自动生成
注意一下,这里html注释稍有不同
因为html注释格式为 < - - ! - - >
"Print to html method": {
"prefix": "csj",
"body": [
"<!-- ",
"**@description",
"-->"
],
}