PhpStorm PHP代码注释自动插入设置

PhpStorm PHP代码注释自动插入设置

设置路径:

PhpStorm -> Prererences… -> File and Code Templates

如下图

PhpStorm PHP代码注释自动插入设置

 PHP 类注释 PHP Class Doc Comment

/**
 * ${CARET}
 * @package ${NAMESPACE}
 * @class ${NAME}
 * @author ${USER} ${YEAR}-${MONTH}-${DAY}
 */

PHP 函数注释 PHP Function Doc Comment

/**
* ${CARET}
${PARAM_DOC}
* @return ${TYPE_HINT}
${THROWS_DOC}
* @author ${USER} ${YEAR}-${MONTH}-${DAY}
*/

PHP 接口注释 PHP Interface Doc Comment

/**
 * ${CARET}
 * @package ${NAMESPACE}
 * @class ${NAME}
 * @author ${USER} ${YEAR}-${MONTH}-${DAY}
 */

PHP 属性注释 PHP Property Doc Comment

/**
 * ${CARET}
 * @var ${TYPE_HINT}
 * @author ${USER} ${YEAR}-${MONTH}-${DAY}
 */

PHP Trait 注释 PHP Trait Doc Comment

/**
 * ${CARET}
 * @package ${NAMESPACE}
 * @class ${NAME}
 * @author ${USER} ${YEAR}-${MONTH}-${DAY}
 */

上面用到的预定义变量说明

${CARET} 光标默认的位置 Marks a position where the caret must be moved after the comment is added.
${NAMESPACE} 命名空间 Fully qualified name of the trait class without a leading slash.
${NAME} 类名,函数名,接口名,属性名,Trait名 Class name, Function name, Interface name, Property name, Trait name
${USER} 当前系统用户名 Current user
${YEAR} Current year
${MONTH} Current month
${DAY}

Current day of the month

更多预定义变量,请查阅每个类型 Template 的详细描述,如下图

PhpStorm PHP代码注释自动插入设置

                       

点击阅读全文

上一篇 2023年 6月 6日 am11:08
下一篇 2023年 6月 6日 am11:09