PHP代码常见注释规范讲解
解释：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释措辞必须准确、易懂、简洁。
/ @version: V1.0 @author: pmdream @className: user @packageName: user @description: 类注释 @data: 2019-9-5 11:20 /
方法注释
/ @author: pmdream @methodsName: addUser @description: 添加一个用户 @param: xxxx @return: String @throws: /
1.注释在写代码的过程中非常主要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要把稳注释的规范。
“php是一门及其随意马虎入门的措辞，刚入门的新手不到几分钟的韶光可能就会用echo打印出一个hello world ！
但是他是真正的程序员吗？怎么来定义程序员呢？如果想真正成为一个程序员，那么就必须遵照一套程序书写规范，”
我们常常编写一些函数，但是这些函数可能也只有自己能看得懂，乃至过一段韶光自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释。
我们可能熟习很多注释的写法C pear PHP注释等等，但我们用到的紧张还是# 和//。
#是一种简短的注释方法。可能你会用它去注释一个变量，或者调用的一个方法。//我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？
注释在写代码的过程中非常主要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要把稳注释的规范。
“php是一门及其随意马虎入门的措辞，刚入门的新手不到几分钟的韶光可能就会用echo打印出一个hello world ！
但是他是真正的程序员吗？怎么来定义程序员呢？如果想真正成为一个程序员，那么就必须遵照一套程序书写规范，”
我们常常编写一些函数，但是这些函数可能也只有自己能看得懂，乃至过一段韶光自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释。
我们可能熟习很多注释的写法C pear PHP注释等等，但我们用到的紧张还是# 和//。
#是一种简短的注释方法。可能你会用它去注释一个变量，或者调用的一个方法。//我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？
/
@name 名字
@abstract 申明变量/类/方法
@access 指明这个变量、类、函数/方法的存取权限
@author 函数作者的名字和邮箱地址
@category 组织packages
@copyright 指明版权信息
@const 指明常量
@deprecate 指明不推举或者是废弃的信息
@example 示例
@exclude 指明当前的注释将不进行剖析，不涌如今文挡中
@final 指明这是一个终极的类、方法、属性，禁止派生、修正。
@global 指明在此函数中引用的全局变量
@include 指明包含的文件的信息
@link 定义在线连接
@module 定义归属的模块信息
@modulegroup 定义归属的模块组
@package 定义归属的包的信息
@param 定义函数或者方法的参数信息
@return 定义函数或者方法的返复书息
@see 定义须要参考的函数、变量，并加入相应的超级连接。
@since 指明该api函数或者方法是从哪个版本开始引入的
@static 指明变量、类、函数是静态的。
@throws 指明此函数可能抛出的缺点非常,极其发生的情形
@todo 指明该当改进或没有实现的地方
@var 定义解释变量/属性。
@version 定义版本信息
/
注释的信息很全面，可能有很多我们用不到，赤色部分是我们常常用到的。
示例：php里面常见的几种注释办法：
1.文件的注释，先容文件名，功能以及作者版本号等信息
/ 文件名大略先容 文件功能 @author 作者 @version 版本号 @date 2019-09-05/
文件头部模板
/ 这是一个什么文件 此文件程序用来做什么的（详细解释，可选。）。 @author richard<e421083458@163.com> @version $Id$ @since 1.0 /
2.类的注释，类名及先容
/ 类的先容 类的详细先容（可选） @author 作者 @version 版本号 @date 2019-09-05/
/ 类的先容 类的详细先容（可选。）。 @author richard<858560031@qq.com> @since 1.0 /
3.函数的注释，函数的浸染，参数先容以及返回类型
/ 函数的含义解释 @access public @author 作者 @param mixed $arg1 参数一的解释 @param mixed $arg2 参数二的解释 @return array 返回类型 @date 2019-09-05/函数
头部注释
/ some_func 函数的含义解释 @access public @param mixed $arg1 参数一的解释 @param mixed $arg2 参数二的解释 @param mixed $mixed 这是一个稠浊类型 @since 1.0 @return array /
程序代码注释
1. 注释的原则是将问题阐明清楚，并不是越多越好。
2. 多少语句作为一个逻辑代码块，这个块的注释可以利用/ /办法。
3. 详细到某一个语句的注释，可以利用行尾注释：//。
/ 天生配置文件、数据文件。/$this->setConfig(); $this->createConfigFile(); //创建配置文件 $this->clearCache(); // 打消缓存文件 $this->createDataFiles(); // 天生数据文件 $this->prepareProxys(); $this->restart();
PHP命名规范
1.目录和文件
目录利用小写+下划线
类库，函数文件统一以.php为后缀
类的文件名均以命名空间定义，并且命名空间的路径和类库文件所在路径同等
类文件采取驼峰法命名（首字母大写），其他文件采取小写+下划线命名
类名和类文件名保持同等，统一采取驼峰法（首字母大写）
2.函数和类，属性命名
类的命名采取驼峰法（首字母大写），例如 User、UserType，默认不须要添加后缀，例如UserController该当直接命名为User
函数的命名利用小写字母和下划线（小写字母开头）的办法，例如 get_client_ip
方法的命名利用驼峰法（首字母小写），例如 getUserName(如果方法有返回值，那么目前习气年夜将首字母用小写的属性类型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等)
属性的命名利用驼峰法（首字母小写），例如 tableName、instance（目前习气年夜将首字母用小写的属性类型，如s(string)，i(int)，f(float)，b(boolean)，a(array)等）
以双下划线“__”打头的函数或方法作为邪术方法，例如 __call 和 __autoload
3.常量和配置
常量以大写字母和下划线命名，例如 APP_PATH和 THINK_PATH
配置参数以小写字母和下划线命名，例如 url_route_on 和url_convert
4.数据表盒字段
数据表和字段采取小写加下划线办法命名，并把稳字段名不要以下划线开头，例如 think_user 表和 user_name字段，不建议利用驼峰和中文作为数据表字段命名。
