持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第24天,点击查看活动详情
写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。
好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~
Vscode支持自定义代码片段
1:快捷键ctrl+shift+p
2:在上图红框标注的位置,输入snippets,按下回车,如下图所示:
3:在上图红框标注位置,输入PHP,按下回车,打开php.json文件,这个PHP代码片段的文件。将如下的内容替换至文件中。
{
// Place your snippets for php here. Each snippet is defined under a snippet name and has a prefix, body and
// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the
// same ids are connected.
// Example:
// "Print to console": {
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"Print to functionComments": {
"prefix": "/**",
"body": [
"/**",
" * @name: ${1:函数名}",
" * @desc: ${2:描述}",
" * @author: camellia",
" * @date: $CURRENT_YEAR$CURRENT_MONTH$CURRENT_DATE",
" * @param: data type description",
" * @return: data type description",
""
],
"description": "函数注释"
}
}
复制代码
当然,具体的根据你自己的需要对注释的格式进行修改。
最后,说一下vscode中snippets的语法:
prefix :代码片段名字,即输入此名字就可以调用代码片段。
body :这个是代码段的主体.需要编写的代码放在这里,
$1 :生成代码后光标的初始位置.
3, 5.....
${1,字符} :生成代码后光标的初始位置(其中1表示光标开始的序号,字符表示生成代码后光标会直接选中字符。)
description :代码段描述,输入名字后编辑器显示的提示信息。
编写的时候注意以下几点:
1:如果没有description,默认提示信息是类似上图中Print to console一样的信息(即key值)
2:代码多行语句的以 , 隔开
3:每行代码需要用引号包裹住
4:字符串间如果值里包含特殊字符需要 进行转义.
换行: 或者
tab键制表符:
5:如果多个,比如{1,字符2} ${2,字符3},光标开始会选中字符1和字符2,点击tab会切换到字符3
看着这部分语法解释,在对照上边的代码片段,大概会对上边的代码有一个大体的了解。
有好的建议,请在下方输入你的评论。
欢迎访问个人博客:guanchao.site
欢迎访问我的小程序:打开微信->发现->小程序->搜索“时间里的”