如何修改PhpStorm的檔頭註解?

在建立一個新的class時，PhpStorm預設會幫你加上檔頭註解，無論是你覺得很礙眼，想將檔頭註解拿掉，或者想將檔頭註解修改成自己想要的格式，都可以參考本文的步驟。

Version

PhpStorm 10.0.1

預設檔頭註解

當你建立PHP Class時，PhpStorm自動會加上檔頭註解如下 :

你可能會覺得很礙眼想將它拿掉，或者改成自己想要的格式，如使用PHPDoc所規定的tag。

設定檔頭註解

設定Preferences

PhpStorm -> Preferences -> Editor -> File and Code Templates -> PHP Class
我們看到了一開始是#parse("PHP File Header.php")，這就是預設的檔頭註解。

選擇Includes與PHP File Header，右側即是預設的檔頭註解格式。

自訂註解格式

若你想將檔頭註解整個拿掉，就清空整個PHP File Header，也可以改成自己想要的格式。

1
2
3
4
5
6
7
8

/**
 * Your file description
 *
 * @version 0.1.0
 * @author ${USER}
 * @date ${DATE}
 * @since ${DATE} description
 */

使用註解格式

以後就可以使用自訂的格式為檔頭註解了。

Conclusion

• 除了可以拿掉惱人的Created by PhpStorm之外，還可以根據團隊的需要，自訂自己的檔頭註解格式。