PHP注释语礼貌范与定名类型详解篇
HP注释类型注释在写代码的进程中很是重要，好的注释能让你的代码读起来更轻松，在写代码的时辰必然要留意注释的类型。 “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.文件的注释，先容文件名，成果以及作者版本号等信息 文件头部模板
* @version $Id$
* @since 1.0
*/
2.类的注释，类名及先容
* @since 1.0
*/
class Test
{
}
3.函数的注释，函数的浸染，参数先容以及返回范例 函数头部注释 措施代码注释 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字段，不提议行使驼峰和中文作为数据表字段定名。 （编辑：湖南网） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
