| 標示 | 作用 |
| --- | --- |
| 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文檔說明規范
- 管理端操作手冊
- 用戶使用說明書
- 溯源項目構想