注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范,这里PHP粉丝网小编就为大家整理一下，需要的朋友可以参考下。

HP注释规范

注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范。

“php是一门及其容易入门的语言，刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world ！但是他是真正的程序员吗？怎么来定义程序员呢？如果想真正成为一个程序员，那么就必须遵循一套程序书写规范，”

我们经常编写一些函数，但是这些函数可能也只有自己能看得懂，甚至过一段时间自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释。

我们可能熟悉很多注释的写法C pear PHP注释等等，但我们用到的主要还是# 和/**/。

#是一种简短的注释方法。可能你会用它去注释一个变量，或者调用的一个方法。/**/我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？

1. /** 
2. * @name 名字 
3. * @abstract 申明变量/类/方法 
4. * @access 指明这个变量、类、函数/方法的存取权限 
5. * @author 函数作者的名字和邮箱地址 
6.  
7. * @category 组织packages 
8. * @copyright 指明版权信息 
9. * @const 指明常量 
10. * @deprecate 指明不推荐或者是废弃的信息 
11. * @example 示例 
12. * @exclude 指明当前的注释将不进行分析，不出现在文挡中 
13. * @final 指明这是一个最终的类、方法、属性，禁止派生、修改。 
14. * @global 指明在此函数中引用的全局变量 
15. * @include 指明包含的文件的信息 
16. * @link 定义在线连接 
17. * @module 定义归属的模块信息 
18. * @modulegroup 定义归属的模块组 
19. * @package 定义归属的包的信息 
20. * @param 定义函数或者方法的参数信息 
21. * @return 定义函数或者方法的返回信息 
22. * @see 定义需要参考的函数、变量，并加入相应的超级连接。 
23. * @since 指明该api函数或者方法是从哪个版本开始引入的 
24. * @static 指明变量、类、函数是静态的。 
25. * @throws 指明此函数可能抛出的错误异常,极其发生的情况 
26. * @todo 指明应该改进或没有实现的地方 
27. * @var 定义说明变量/属性。 
28. * @version 定义版本信息 
29. */ 

注释的信息很全面，可能有很多我们用不到，红色部分是我们经常用到的。

示例：php里面常见的几种注释方式：

1.文件的注释，介绍文件名，功能以及作者版本号等信息

1. /** 
2. * 文件名简单介绍 
3. *  
4. * 文件功能 
5. * @author 作者 
6. * @version 版本号 
7. * @date 2020-02-02 
8. */ 

文件头部模板

1. /**  
2. *这是一个什么文件  
3. *  
4. *此文件程序用来做什么的（详细说明，可选。）。  
5. * @author   richard<e421083458@163.com>  
6. * @version   $Id$  
7. * @since    1.0  
8. */ 

2.类的注释，类名及介绍

1. /** 
2. * 类的介绍 
3. *  
4. * 类的详细介绍（可选） 
5. * @author 作者 
6. * @version 版本号 
7. * @date 2020-02-02 
8. */ 
9.  
10. /**  
11. * 类的介绍  
12. *  
13. * 类的详细介绍（可选。）。  
14. * @author     richard<e421083458@163.com>  
15. * @since     1.0  
16. */ 
17. class Test   
18. {  
19. } 

3.函数的注释，函数的作用，参数介绍以及返回类型

1. /** 
2. * 函数的含义说明 
3. *  
4. * @access public  
5. * @author 作者 
6. * @param mixed $arg1 参数一的说明  
7. * @param mixed $arg2 参数二的说明 
8. * @return array 返回类型 
9. * @date 2020-02-02 
10. */ 

函数头部注释

1. /**  
2. * some_func  
3. * 函数的含义说明  
4. *  
5. * @access public  
6. * @param mixed $arg1 参数一的说明  
7. * @param mixed $arg2 参数二的说明  
8. * @param mixed $mixed 这是一个混合类型  
9. * @since 1.0  
10. * @return array  
11. */ 
12. public function thisIsFunction($string, $integer, $mixed) {return array();} 

程序代码注释

1. 注释的原则是将问题解释清楚，并不是越多越好。

2. 若干语句作为一个逻辑代码块，这个块的注释可以使用/* */方式。

3. 具体到某一个语句的注释，可以使用行尾注释：//。

1. /* 生成配置文件、数据文件。*/ 
2.    
3. $this->setConfig();  
4. $this->createConfigFile(); //创建配置文件  
5. $this->clearCache();     // 清除缓存文件  
6. $this->createDataFiles();  // 生成数据文件  
7. $this->prepareProxys();  
8. $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字段，不建议使用驼峰和中文作为数据表字段命名。

Tags: PHP注释语法 PHP命名规范

分享到：