YII2项目中重写PhpStorm中对方法function的注释代码

41次阅读

共计 1056 个字符,预计需要花费 3 分钟才能阅读完成。

1 说明

Yii2 默认的可访问的路由都是 action 开头的,但是当项目多了 action 名称变长了,每次都要转换大小写对 action 进行全局的搜索,很是不方便,所以重写了 phpstorm 对 function 注释的工具,这样我们写好 action 方法的时候只要输入 /** 然后再按一个回车就可以出现以下代码了,如下图,自动对 action 进行了拆分,这样就能愉快的搜索了

2 操作步骤

·依次打开 File->Settings->Editor->File and Code Templates(或者使用快捷键 ctrl+shift+s)
·找到界面右侧的 Includes, 再点击 PHP Function Doc Comment, 接着把以下代码复制进去,点击 apply->ok 即可

3、配置代码

/**
* @note: 
#if($NAME.length()>6)
    #set($formatAction = '')
    #if($NAME.substring(0,6) == 'action')
        #set($len = $NAME.length())
        #set($actionName = $NAME.substring(6,$len))
        #set($actionLen = ${len} - 6 - 1)
        #foreach($start in [0..$actionLen])
            #set($end = ${start} + 1)
            #set($tmpStr = $actionName.substring($start,$end))
            #if($tmpStr.toUpperCase() == $tmpStr)
                #set($tmpLowerStr = $tmpStr.toLowerCase())
                #if($start != 0)
                    #set($formatAction = "${formatAction}-")   
                #end
                #set($formatAction = "${formatAction}${tmpLowerStr}")
            #else
                #set($formatAction = "${formatAction}${tmpStr}")
            #end
        #end
    * @action $formatAction
    #else
        * @func $NAME  
    #end
#else
    * @func $NAME    
#end
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

4、相关网站

http://velocity.apache.org/en…
https://wizardforcel.gitbooks…

正文完
 0