PhpStorm修改自动生成注释默认模板

File -> Settings -> Editor -> Code Style -> File and Code Templates -> 修改PHP Function Doc Comment

把注释默认模板替换为下面的代码即可

------------------------- 俺是分割线，请勿复制俺 -------------------------

/**

* 当前函数或方法的说明

* @author 码农人生<1104187@qq.com>

* @project ${PROJECT_NAME}

* @product ${PRODUCT_NAME}

* @user ${USER}

* @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}

#set( $PARAMS_ARR = $PARAM_DOC.split("\n") )

#foreach( $PARAM in ${PARAMS_ARR} )

#set( $PARAM_SPLIT = $PARAM.split(" ") )

#if ($PARAM_SPLIT.size() == 3)

#set( $TMP1 = $PARAM_SPLIT.get(1) )

#set( $TMP2 = $PARAM_SPLIT.get(2) )

${TMP1} mixed ${TMP2} 参数说明

#end

#if ($PARAM_SPLIT.size() == 4) ${PARAM} 参数说明 #end

#end

#if (${TYPE_HINT} == "void") * @return void #end

#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT} 返回值说明 #end

${THROWS_DOC}

------------------------- 俺是分割线，请勿复制俺 -------------------------

下面是具体效果展示：

<?php
/**
 * 当前函数或方法的说明
 *
 * @author 码农人生<1104187@qq.com>
 * @project www.domain.com
 * @product PhpStorm
 * @user 程序猿
 * @date 2008-08-08 08:08:08
 * @param mixed $name 参数说明
 * @param mixed $gender 参数说明
 * @param mixed $age 参数说明
 * @return void
 */
function func1($name, $gender, $age)
{
    $profile = [];

    $profile['name'] = $name;
    $profile['gender'] = $gender;
    $profile['age'] = $age;

    unset($profile);
}

/**
 * 当前函数或方法的说明
 *
 * @author 码农人生<1104187@qq.com>
 * @project www.domain.com
 * @product PhpStorm
 * @user 程序猿
 * @date 2008-08-08 08:08:08
 * @param string $name 参数说明
 * @param string $gender 参数说明
 * @param int $age 参数说明
 * @return array 返回值说明
 */
function func2(string $name, string $gender, int $age): array
{
    $profile = [];

    $profile['name'] = $name;
    $profile['gender'] = $gender;
    $profile['age'] = $age;

    return $profile;
}

//========== 总结 ==========//
// 1、在函数名的上一行输入“/**”然后回车即可自动生成该函数的注释。
// 2、如果形参没有声明数据类型，那么自动生成的注释也没有数据类型。
// 3、强烈建议形参声明数据类型，即便没有使用declare(strict_types=1)开启严格模式，如果使用PHP7+最好连返回值也声明数据类型。
// 3、PhpStorm的生成注释功能是依靠Velocity模板引擎实现的。