1. 程式人生 > >PHPStorm使用之四(新增文件註釋)

PHPStorm使用之四(新增文件註釋)

之前有提到註釋,那註釋能不能自動生成呢
答案是肯定的,設定如下圖:

在這裡插入圖片描述

step1
file ----- setting ---- editor ------ file and code templates

step2
選擇左側的需要文件註釋的模組 比如 函式

step3
編寫註釋文件,一般有預設的文件,不需要改動
只是我們在新增部分註釋規則的時候,如果需要用到變數
比如 : 日期
在註釋內容的下方 Description 裡找到可以用的變數 ${DATE}
加在註釋內容裡

 * @date ${DATE}

step 5 & 6
應用 後 確定

step7
使用方式是,先宣告函式 比如:

public function add($a = 0, $b = 0)
{
    return $a + $b;
}

然後在 函式上方的行首輸入 /** ,回車
即可看到註釋自動新增完成

/**
 * @todo: 要做啥
 * @author:friker
 * @date: 2018/12/12
 * @param int $a
 * @param int $b
 * @reutrn int
 */
public function add($a = 0
, $b = 0){ return $a + $b; }