PhpStorm函數註釋的設置
一、首先,PhpStorm中文件、類、函數等註釋的設置在:setting-》Editor-》FIle and Code Template-》Includes下設置即可,其中方法的默認是這樣的:
/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
${THROWS_DOC}
*/
二、但是我發現,文件中的默認註釋是這樣的:
/**
* Created by ${PRODUCT_NAME}.
* User: ${USER}
* Date: ${DATE}
* Time: ${TIME}
*/
三、當我把上面這段中3、4、5行的代碼直接複製放到PHP Function Doc Comment這個下面的時候,發現其中佔位符{}中的東西並沒有被替換,而是當成字符串打出來了。
四、方法:
1、我們在PhpStorm中setting-》Editor-》Live Template,即找到模板選項,會看到各種語言的模板設置;
2、找到右邊有個+號,創建一個自定義模板:選擇Live Template,然後按照下圖的配置順序進行設置:
3、點保存之後,回到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}
*/
4、點擊Apply,點擊OK,然後在方法前面,輸入 /**後回車:
/**
* Notes:下單接口
* User: Steven
* Date: 2017/12/28
* Time: 15:19
* @return array
* @throws \yii\db\Exception
*/