vscode设置php自定义注释格式

简介: 写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~

写代码一般的注释都是有格式的,方便自己和他人阅读代码,多人开发的时候,也能更快的找到这部分代码是由谁来编写的。

好的代码注释确实是一个好习惯,但是,有的时候就是这玩意有敲起来有点费劲~

Vscode支持自定义代码片段

1:快捷键ctrl+shift+p

image.png

2:在上图红框标注的位置,输入snippets,按下回车,如下图所示image.png

3:在上图红框标注位置,输入PHP,按下回车,打开php.json文件,这个PHP代码片段的文件。将如下的内容替换至文件中。

perl

复制代码

{
    // 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          :生成代码后光标的初始位置.

2         :生成代码后光标的第二个位置,按tab键可进行快速切换,还可以有2          :生成代码后光标的第二个位置,按tab键可进行快速切换,还可以有2         :生成代码后光标的第二个位置,tab键可进行快速切换,还可以有3,4,4,4,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

欢迎访问我的小程序:打开微信->发现->小程序->搜索“时间里的”

目录
相关文章
VScode用户自定义代码片段
VScode用户自定义代码片段
220 0
vscode 向下复制当前行功能快捷键 设置成Ctrl + D
vscode 向下复制当前行功能快捷键 设置成Ctrl + D
2519 0
|
11月前
|
C++ Windows
Windows10添加自定义右键菜单VS Code
本文介绍了如何在Windows 10中通过修改注册表,将VS Code添加到右键菜单,实现右键文件、文件夹或空白处时使用VS Code打开。方法同样适用于其他程序,如Sublime Text 3。
|
PHP 开发者
PHP数据验证方法:如何检查一个字符串是否是email格式。
以上就是关于PHP如何检查一个字符串是否是email格式的全部内容。希望你在代码书写旅途中,能找到你的北斗星——简洁、高效、可靠的代码验证方式。让我们共同见证PHP的强大和丰富多彩!
308 16
|
Android开发
Vscode中注释变成繁体的解决方法
这篇文章提供了两种解决Vscode中注释变成繁体字的方法:第一种是通过设置语言模式来更改显示语言;第二种是更改文件的编码格式,如在UTF-8和GBK之间切换,以解决乱码问题。
Vscode中注释变成繁体的解决方法
|
前端开发 搜索推荐 C++
Marp 教程:如何在 VSCode 中引入自定义样式和主题
本文介绍了如何在 Marp 中引入自定义样式和主题,使你的幻灯片更加个性化和独特。首先,你需要安装 VSCode 和 Marp 插件,了解 Marp 的基本结构。接着,通过创建自定义 CSS 文件并在 Markdown 文件中引入,实现样式定制。此外,还可以创建和使用自定义主题,以及进行高级自定义,如调整布局、引入自定义字体和定义复杂动画。最后,使用 Marp 的预览功能实时查看效果。
|
PHP
在 PHP 中将 WebP 转换为 GIF 图像格式
【8月更文挑战第27天】
362 2
进入靶场,出现一张照片,右击查看源代码,发现有一个注释的source.php文件
这段代码实现了一个网站上弹出的促销海报动画效果,包含一个关闭按钮。当促销海报弹出时,会在三秒后开始抖动一两下。海报使用固定定位居中显示,带有阴影和圆角,关闭按钮位于右上角。可以通过修改时间参数调整弹出时间。
169 0
|
JavaScript 索引
vscode中快捷生成自定义vue3模板
vscode中快捷生成自定义vue3模板
3109 1
|
JSON Ubuntu JavaScript
工具分享:VsCode注释神器,koro1FileHeader
工具分享:VsCode注释神器,koro1FileHeader
824 3