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

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

目录
相关文章
|
8月前
VScode用户自定义代码片段
VScode用户自定义代码片段
55 0
|
8月前
vscode 向下复制当前行功能快捷键 设置成Ctrl + D
vscode 向下复制当前行功能快捷键 设置成Ctrl + D
495 0
|
8月前
设置VSCode运行任务命令快捷键Alt+R,通常用于npm start(对频繁使用该命令可节省50%的输入命令行打字时间)
设置VSCode运行任务命令快捷键Alt+R,通常用于npm start(对频繁使用该命令可节省50%的输入命令行打字时间)
|
3月前
|
PHP 数据库 开发者
PHP中的异常处理和自定义异常
【10月更文挑战第3天】在PHP编程中,异常处理是一个重要的话题。它允许开发者优雅地处理错误,提高代码的可读性和可维护性。本文将介绍如何在PHP中进行异常处理,包括基本的try-catch结构,以及如何创建和使用自定义异常类来处理特定的错误情况。通过实际示例,我们将看到如何使用异常处理机制来增强应用程序的健壮性和灵活性。
35 1
|
4月前
|
PHP 数据安全/隐私保护 UED
PHP中实现自定义错误处理与异常管理
【9月更文挑战第2天】在PHP开发过程中,错误处理和异常管理是保证应用健壮性的关键。本文将引导你了解如何在PHP中创建自定义错误处理器,并通过实际代码示例展示如何有效捕获和处理异常,确保你的应用程序能够优雅地处理运行时出现的问题。
|
4月前
|
搜索推荐 PHP UED
PHP中的异常处理与自定义错误页面
【8月更文挑战第33天】在PHP开发中,优雅地处理异常和错误是提升应用稳定性和用户体验的关键。本文将引导你理解PHP的异常处理机制,并教你如何创建自定义错误页面,以增强你的应用对错误的响应能力。从基本的错误类型到深入的异常捕获,再到实现个性化的用户提示,我们将一步步构建一个更加健壮的PHP应用。
45 4
|
5月前
|
PHP
在 PHP 中将 WebP 转换为 GIF 图像格式
【8月更文挑战第27天】
105 2
|
5月前
|
PHP 开发工具 git
【Azure 应用服务】在 App Service for Windows 中自定义 PHP 版本的方法
【Azure 应用服务】在 App Service for Windows 中自定义 PHP 版本的方法
|
5月前
|
JavaScript PHP 开发者
PHP中的异常处理与自定义错误处理器构建高效Web应用:Node.js与Express框架实战指南
【8月更文挑战第27天】在PHP编程世界中,异常处理和错误管理是代码健壮性的关键。本文将深入探讨PHP的异常处理机制,并指导你如何创建自定义错误处理器,以便优雅地管理运行时错误。我们将一起学习如何使用try-catch块捕获异常,以及如何通过set_error_handler函数定制错误响应。准备好让你的代码变得更加可靠,同时提供更友好的错误信息给最终用户。
|
7月前
|
JSON Ubuntu JavaScript
工具分享:VsCode注释神器,koro1FileHeader
工具分享:VsCode注释神器,koro1FileHeader
260 3