PhpStorm 頭部註釋、類註釋和函式註釋的設定(稍微完善點)...
阿新 • • 發佈:2019-01-26
首先,PhpStorm中檔案、類、函式等註釋的設定在:setting-》Editor-》FIle and Code Template-》Includes下設定即可,其中方法的預設是這樣的:
/** ${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 */
當我把上面這段中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: * @Interface ${NAME} ${PARAM_DOC} #if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} #end ${THROWS_DOC} * @author: Chenrui * @Time: ${DATE} ${TIME} */
4、點選Apply,點選OK,然後在方法前面,輸入 /**後回車:
/** * @Notes: * @Interface put_token * @param $data * @return string * @author: Chenrui * @Time: 2018/5/9 18:05 */
OK,完成。