php psr2 註釋規範

1. 文檔頭部註釋

設置 > Editor > File and Code Templates > Includes選項卡 > PHP File Header

/**
 * Created by ${PRODUCT_NAME}.
 * User: *****
 * Date: ${DATE}
 * Time: ${TIME}
 * PHP version 7
 
 * @category Private
 #if (${NAMESPACE}) 
 * @package  ${NAMESPACE}
 #end
 * @author   fzy <[email protected]>
 * @license  FZY https://[email protected]
 * @link     https://[email protected]
 */

2. 函數頭部設置

/**
${PARAM_DOC}

#if (${TYPE_HINT} != "void") 

* @return ${TYPE_HINT}

#end

${THROWS_DOC}
*/

 

例子：

/**
 * 分頁數據
 *
 * @param array $data  參數
 * @param int   $total 總數
 *
 * @return array 結果
 */

3、類註釋

/**
 * Class ${NAME}
 *
 * @category Private
 #if (${NAMESPACE}) 
 * @package  ${NAMESPACE}
 #end
 * @author   fzy <[email protected]>
 * @license  FZY https://[email protected]
 * @link     https://[email protected]
 */