PhpStorm函數註釋的設置

首先,PhpStorm中文件、類、函數等註釋的設置在:setting-》Editor-》FIle and Code Template-》Includes下設置便可,其中方法的默認是這樣的:yii

/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

可是我發現,文件中的默認註釋是這樣的:函數

1 /**
2  * Created by ${PRODUCT_NAME}.
3  * User: ${USER}
4  * Date: ${DATE}
5  * Time: ${TIME}
6  */

當我把上面這段中三、四、5行的代碼直接複製放到PHP Function Doc Comment這個下面的時候,發現其中佔位符{}中的東西並無被替換,而是當成字符串打出來了。spa

方法:code

一、咱們在PhpStorm中setting-》Editor-》Live Template,即找到模板選項,會看到各類語言的模板設置;orm

二、找到右邊有個+號,建立一個自定義模板:選擇Live Template,而後按照下圖的配置順序進行設置:blog

三、點保存以後,回到FIle and Code Template-》Includes,在PHP Function Doc Comment這裏設置:接口

/**
 * Notes:
 * User: ${USER}
 * Date: ${DATE}
 * Time: ${TIME}
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/

四、點擊Apply,點擊OK,而後在方法前面,輸入 /**後回車:字符串

 

/**
     * Notes:下單接口
     * User: Steven
     * Date: 2017/12/28
     * Time: 15:19
     * @return array
     * @throws \yii\db\Exception
     */

OK,完成。it

相關文章
相關標籤/搜索