注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

onefish资料库

成功要素---耐得住孤独!

 
 
 

日志

 
 

PHP Document 注释标记及规范 && PHP命名规范  

2014-11-22 21:03:36|  分类: php |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

注释标记

@access

  • 使用范围:class,function,var,define,module
  • 该标记用于指明关键字的存取权限:private、public或proteced

@author

  • 指明作者

@copyright

  • 使用范围:class,function,var,define,module,use
  • 指明版权信息

@deprecated

  • 使用范围:class,function,var,define,module,constent,global,include
  • 指明不用或者废弃的关键字

@example

  • 该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容

@const

  • 使用范围:define
  • 用来指明php中define的常量

@final

  • 使用范围:class,function,var
  • 指明关键字是一个最终的类、方法、属性,禁止派生、修改。

@filesource

  • 和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。

@global

  • 指明在此函数中引用的全局变量


@ingore

  • 用于在文档中忽略指定的关键字

@license

  • 相当于html标签中的<a>,首先是URL,接着是要显示的内容
  • 例如<a href=”http://www.baidu.com”>百度</a>
  • 可以写作 @license http://www.baidu.com 百度

@link

  • 类似于license
  • 但还可以通过link指到文档中的任何一个关键字

@name

  • 为关键字指定一个别名。

@package

  • 使用范围:页面级别的-> define,function,include
  • 类级别的->class,var,methods
  • 用于逻辑上将一个或几个关键字分到一组。

@abstrcut

  • 说明当前类是一个抽象类

@param

  • 指明一个函数的参数

@return

  • 指明一个方法或函数的返回指

@static

  • 指明关建字是静态的。

@var

  • 指明变量类型

@version

  • 指明版本信息

@todo

  • 指明应该改进或没有实现的地方

@throws

  • 指明此函数可能抛出的错误异常,极其发生的情况
  • 普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:

{@link}

  • 用法同@link

{@source}

  • 显示一段函数或方法的内容

注释规范

a.注释必须是

的形式

b.对于引用了全局变量的函数,必须使用glboal标记。

c.对于变量,必须用var标记其类型(int,string,bool…)

d.函数必须通过param和return标记指明其参数和返回值

e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可

f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的阅读。

g.必要的地方使用非文档性注释,提高代码易读性。

h.描述性内容尽量简明扼要,尽可能使用短语而非句子。

i.全局变量,静态变量和常量必须用相应标记说明

示例

22function firstFunc($param1$param2 'optional') {
23    static $staticvar = 7;

phpDocumentor官方网站


YII框架的注释范例:

48class CHttpSession implements IteratorAggregate, ArrayAccess, Countable {
53    public $autoStart = true;
54    private static $_instance = NULL;
60    public function init() {
61        if ($this->autoStart) {
62            $this->open();
66        register_shutdown_function(array($this'close'));
78    public function getUseCustomStorage() {
90    public function openSession($savePath$sessionName) {

PHP命名规范

先了解下 

1、什么是 驼峰命名法?  百度百科   

2、大驼峰 与 小驼峰 的区别 ?   百度百科    

1.类名:大驼峰命名法

2.类属性

public、protected类型的,小驼峰命名法;

private类型的,下划线(_)开头,小驼峰命名法;

3.类方法

public、protected类型的,小驼峰命名法;

private类型的,下划线(_)开头,小驼峰命名法;

4.类方法参数:小驼峰命名法;

5.函数:采用C GNU的惯例,所有的字母使用小写字母,使用下划线(_)分割单词;

6.函数参数:小驼峰命名法;

例如:

function some_bloody_function($userId, $userName) {

}

7.常量

所有字母都大写,使用下划线(_)分割单词;

  评论这张
 
阅读(100)| 评论(0)
推荐 转载

历史上的今天

在LOFTER的更多文章

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017