PhpStorm函數註釋的設置

PhpStorm函數註釋的設置

1、總結

一句話總結：

添加模板 添加變量

應用變量

a、添加模板，添加變量，在（PhpStorm中setting-》Editor-》Live Template）中添加模板添加變量

$DATE$ $TIME$

 

b、應用變量，在（setting-》Editor-》FIle and Code Template-》Includes）中應用變量

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

 

 

一、phpstorm中如何給方法函數添加註釋？

在方法前面，輸入 /**後回車

 

二、方法（函數）註釋樣例？

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

應用這樣樣例獲得的註釋結果：

/**
 * Notes:
 * User: rfan
 * Date: 2018-11-04
 * Time: 7:13 AM
 * @param $param1
 * @param $param2
 * @param $param3
 * @return \think\response\View|void
 * @throws \think\db\exception\DataNotFoundException
 * @throws \think\db\exception\ModelNotFoundException
 * @throws \think\exception\DbException
 */

 

 

三、咱們想設置各類模板樣例在哪裏設置，好比html文件的默認代碼，好比類、方法等的註釋？

setting editor templates

File->Setting->Editor->File and Code Templates

 

 

 

2、PhpStorm函數註釋的設置

首先，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  */

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

方法：

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

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

三、點保存以後，回到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，完成。

 

參考：PhpStorm函數註釋的設置 - Steven* - 博客園 https://www.cnblogs.com/Steven-shi/p/8136081.html