×

第一章 PHP编写规范

PHP开发编码规范 编写目的

第二章 PHP整体要求

PHP开发编码规范 整体要求

第三章 PHP安全规范

3.1 PHP包含文件

3.1.1 PHP命名规则3.1.2 PHP存放规则3.2 PHP安全规则3.3 一些针对PHP的规则

3.4 PHP其它处理规则

3.4.1 PHP对输入参数值进行转义处理3.4.2 PHP操作大HTML文本

第四章 PHP编码规范

4.1 PHP命名规范4.1.1 PHP 变量命名4.1.2 PHP 类命名4.1.3 PHP 方法或函数4.1.4 PHP 缩写词4.1.5 PHP 数据库表名4.1.6 PHP 数据库字段4.2 PHP书写规则4.2.1 PHP 代码缩进4.2.2 PHP 大括号{ }书写规则4.2.3 PHP 小括号( )和函数、关键词等4.2.4 PHP =符号书写4.2.5 PHP if else swith for while等书写4.2.6 PHP 类的构造函数4.2.7 PHP 语句断行, 每行控制在80个字符以内4.2.8 PHP 不要不可思议的数字4.2.9 PHP true/false和0/1判断4.2.10 PHP 避免嵌入式赋值4.2.11 PHP 错误返回检测规则4.3 PHP程序注释4.3.1 PHP程序头注释块4.3.2 PHP类的注释4.3.3 PHP函数和方法的注释4.3.4 PHP变量或者语句注释4.4 PHP其他规范(建议)4.4.1 php代码标记4.4.2 PHP程序文件名、目录名4.4.3 PHP项目通常的文件目录结构4.4.4 PHP和HTML代码的分离问题4.4.5 PHP项目开发中的程序逻辑结构

第五章 特定环境下PHP编码特殊规范

5.1 PHP变量定义5.2 PHP引用的使用5.3 PHP变量的输入输出

4.3.4 PHP变量或者语句注释


程序中变量或者语句的注释遵循以下原则:
a. 写在变量或者语句的前面一行,而不写在同行或者后面;
b. 注释采用/* */的方式;
c. 每个函数前面要包含一个注释块。内容包括函数功能简述,输入/输出参数,预期的返回值,出错代码定义。
d. 注释完整规范。
e. 把已经注释掉的代码删除,或者注明这些已经注释掉的代码仍然保留在源码中的特殊原因。
例子:

/** 
* @Purpose: 
* 数据库连接用户名 
* @Attribute/Variable Name: db_user_name 
* @Type: string 
*/ 
var db_user_name;



分类导航

关注微信下载离线手册

bootwiki移动版 bootwiki
(群号:472910771)