PHP代码规范-注释

注释

  • 注释需要写在代码的前面
  • 单行语句,注释应该放在语句的尾部
  • 大段注释采用/**/,代码内部统一采用//
  • 注释不宜太多,大家看得懂的行不必注释

行注释

  • “// ”后面需要添加一个空格;排版需要在注释对象上面,并且趋于相同起点.

函数、方法、类注释

  • 参数名,属性名,标签的文本,需要在注释对象上面并且趋于相同起点,上下对齐.

Phpstrom 模板注释教程:

文件注释模块注释:

参考规则:
    包含本程序的描述:
    包含项目的名称:
    包含文件的名称:
    包含书写的日期:
    包含版本信息:
    包含重要的使用说明(如类的调用方法、注意事项):

/**
* XXX 项目
* LICENSE*
* 本代码来自于XXX项目,XXX有限公司 X设计部*
*
* Description :
* Copyright (c), 2018,XXX有限公司 XX设计部
* FileName : ${FILE_NAME}.
* Author : XXX
* Email : XX@XXX.com
* DateTime: ${DATE} ${TIME}
*/

类注释:

/**
* Class ${NAME}
#if (${NAMESPACE}) * @package ${NAMESPACE}
#end
*/

方法注释:

/**
${PARAM_DOC}
#if (${TYPE_HINT} != "void") * @return ${TYPE_HINT}
#end
@Description :
${THROWS_DOC}
*/

接口注释:

/**
* Interface ${NAME}
#if (${NAMESPACE}) * @package ${NAMESPACE}
#end
@Description :
*/

Trait(特性)注释:

/**
* Trait ${NAME}
#if (${NAMESPACE}) * @package ${NAMESPACE}
#end
@Description :
*/
上一篇