若转载教程,请注明出自SW-X框架官方文档

VsCode快捷注解配置

使用VsCode编辑器,可以配置快捷键,快速生成相应的注释内容,这样更有利于统一项目的注释风格。

步骤

选择【文件】->【首选项】->【用户代码片段】->编辑器顶部弹窗的下拉框中,选择【PHP】
然后替换成输入以下代码:

{
    "main":{
        "prefix":"zzz",
        "body":[
            "/**\n * 函数描述\n * @todo 无\n * @author 小黄牛\n * @version v2.5.0 + $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE\n * @deprecated 暂不启用\n * @global 无\n * @param string $\n * @param mixed $\n * @return void\n*/"
        ],
        "description":"插入函数头"
    },
    "top":{
        "prefix":"xxx",
        "body":[
            "/**\n * +----------------------------------------------------------------------\n * 应用入口\n * +----------------------------------------------------------------------\n * 官网:https://www.sw-x.cn\n * +----------------------------------------------------------------------\n * 作者:小黄牛 <1731223728@qq.com>\n * +----------------------------------------------------------------------\n * 开源协议:http://www.apache.org/licenses/LICENSE-2.0\n * +----------------------------------------------------------------------\n*/"
        ],
        "description":"文件头"
    },
    "headers":{
        "prefix":"ccc",
        "body":[
            "/**\n * \n*/"
        ],
        "description":"成员属性头"
    }
}

这样在.php文件中,我们就可以使用键盘,输入:

xx:获得 文件描述 注释。
zz:获得 函数方法 注释。
cc:获得 成员属性 注释。

免费教程手写不易,希望能支持一下SW-X框架,(^.^)

GitHub有账号的朋友,也可以给我们一个小星星噢!

希望能够与大家共同培育出良好的Swoole生态,对Swoole有兴趣的朋友可以加我微信好友,进入SW-X框架官方交流群。
该群以Swoole生态发展交流为主,若出现争吵,攻击其他人等行为,立即剔除。