| 标示 | 作用 |
| --- | --- |
| access | 该标记用于指明关键字的存取全权限。 可以是:private,public,proteced。 使用范围:class,function,var,define,module。 |
| author | 指明作者。 |
| copyright | 指明版权信息。 |
| const | 指明PHP中的define的常量。 使用范围:define。 |
| final | 指明关键字是一个最终的类、方法、属性,禁止派生,修改。 使用范围:class,function,var。 |
| global | 指明在此函数中引用的全局变量。 |
| name | 为关键字指明一个别名。 |
| package | 用于逻辑上将一个或几个关键字分到一组。 |
| abstract | 说明当前累是一个抽象类。 |
| param | 指明一个函数的参数。 |
| return | 指明一个函数的返回值。 |
| static | 指明关键字是静态的。 |
| var | 指明变量类型。 |
| version | 指明版本信息。 |
| todo | 指明应该改进或者没有实现的地方。 |
| link | 可以通过link指到文档中的任何一个关键字。 |
| ignore | 用于在文档中忽略制定的关键字。 |
>[info]PHP注释有三种语法:
~~~php
// 这样事单行注释
# 这样也是单行注释,但是很多教程里并没有说这种方式
/*
* 这样是多行注释
*/
~~~
~~~
/**
* XXXXX的文件
*
* 功能1: xxx
* 功能2: xxx
*
* @file
* @package core
* @author Joy <author@yunzhongkan.com>
* @version $Id: php开发注释规范.txt,v 1.1 2014/03/04 20:37:46 Joy Exp $
* @link http://www.yunzhongkan.com
*/
~~~
~~~
/**
* Class 类名
* @package 命名空间
* 等等
*/
~~~
~~~
/**
* 函数的含义说明
*
* @access public
* @param mixed $arg1 参数一的说明
* @param mixed $arg2 参数二的说明
* @param mixed $mixed 这是一个混合类型
* @return array 返回类型
*/
~~~
- 序言
- 为什么要编码规范?
- 如何进行编码规范?
- 编码规范宏观微观细节
- PHP编码规范
- 基础规范
- 1 语法规范
- 2 变量命名规范
- 3 常量命名规范
- 4 类命名规范
- 5 函数命名规范
- 6 方法命名规范
- PSR-规范
- 基本代码规范
- Tp项目规范
- TP命名规范
- Tp目录规范
- Tp基础目录构架
- Tp项目开发思考
- Tp控制器规范
- 控制器构架
- Tp模型规范
- 模型性能优化
- Tp业务规范
- 返回结构规范
- 业务异常规范
- Tp输出规范
- Restful API
- 模板渲染输出
- Tp异常规范
- 异常码状态码
- 异常输出方式
- Tp验证规范
- Tp路由规范
- Tp加密规范
- Password Hashing
- Tp缓存规范
- 常见数据缓存
- 缓存设计思考
- Tp日志规范
- 日志信息
- 日志分析
- Tp日志接管分析
- Tp性能优化
- vendor包规范
- 项目自动化思考
- 项目检测告警思考
- 项目注释规范
- Mysql设计规范
- 序言
- 命名规范
- 表及字段规范
- 索引规范
- 索引原理
- Sql规范
- 事务规范
- 读写分离
- 乐观锁悲观锁
- 数据库审计
- 性能优化
- 查询优化神器
- 慢查询优化步骤
- 分库分表、分区表
- 根据sql日志筛选数据
- 设计原则
- MongoDB规范
- MongoDB基础
- MongoDB设计
- MongoDB安全性
- MongoDB备份
- 操作手册规范
- API文档说明规范
- 管理端操作手册
- 用户使用说明书
- 溯源项目构想