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 */

當我把上面這段中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
*/

我自己設置

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

  

 

 

OK,完成。
---------------------
版權聲明:本文為CSDN博主「chenrui310」的原創文章,遵循CC 4.0 by-sa版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/chenrui310/article/details/80257433


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM