Magki's Blog

PHP 编程最好能做好各种注释，不管是用 IDE 还是编辑器进行代码编写，良好的注释总能给予极大的帮助。对于 phpDoc 注释的用法这里做点简单的说明。

/**
* @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 笔记

一个良好的命名规则能让代码变得更加清晰流畅，不仅令别人阅读方面，就是自己维护起来也能减少许多麻烦，这里搜集整理了一点关于变量命名的资料一起分享。

string 字符串型，在变量前面加 str
eg：
　　//下面一个变量为字符串
　　$strMessage = 'Hello World!' ;

array 数组型，在变量前面加 a，一维数组使用名词单数，多维数组使用词复数
eg:
　　//下面一个变量为一维数组
　　$aData = array ( 1 , 2 , 3 , 4 , 5 ,6) ;
　　//下面一个变量为多维数组
　　$aMembers = array ( 'id' => 123456 , 'username' => 'ABC' , 'email' => 'abc#abc.com' ) ;

integer 整数型变量，在前面加上 n
eg:
　　//下面一个变量为整数
　　$nCount = $pBS->Member->getCount() ;

boolean 布尔型变量，在前面加上 b
eg:
　　//下面一个变量为布尔型
　　$bEncode = true ;

float 浮点型变量，在前面加上 f
eg:
　　//下面一个变量为浮点型
　　$fSave = 0.8 ;

阅读全文...

PHP