PHP文件注释标记及规范小结_php基础

PHP 注释标记

@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.全局变量,静态变量和常量必须用相应标记说明

时间: 2024-09-20 22:11:19

PHP文件注释标记及规范小结_php基础的相关文章

PHP文件注释标记及规范小结

PHP 注释标记 @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 指明不用或者废弃

PHP 代码规范小结_php基础

命名规范 Θ 类文件都以.class.php为后缀,使用驼峰法命名,并且首字母大写,例如 Pay.class.php; Θ 类名和目录_文件名一致.例如:类名Zend_Autoloader的目录是Zend/Autoloader.class.php; Θ 函数的命名使用小写字母和下划线的方式.例如:get_client_ip; Θ 方法的命名使用驼峰法,首字母小写或者使用下划线"_",例如listComment(),_getResource(),通常下划线开头的方法属于私有方法; Θ 属

Win2000+Apache+MySql+PHP4+PERL安装使用小结_php基础

Windows 2000+Apache+MySql+PHP3+PHP4+PERL安装使用小结 www.1000script.com 2002-9-3 1000script专业脚本 Windows 2000+Apache+MySql+PHP3+PHP4+PERL安装使用小结(一) 这里一定有许多和我一样喜欢尝试新鲜事物的朋友,尤其是当听说 某某软件有了新的版本时一定也会迫不及待的去下载一份回来用用再说. 这里我想和大家探讨一下以下流行软件的应用,意在抛砖引玉. OS : Microsoft Win

PHP编程风格规范分享_php基础

说明:本规范由 EasyChen 借鉴 SINA网络应用开发部<C++开发规范>和互动技术部<PHP4开发规范>,以及phpDocument规范 整理出的开发规范.我觉得非常不错, 适合PHP的开发,给大家参考,养成一个良好的编程风格是非常有必要的. 第1章 命名规范 1.1变量 1.1.1全局变量 全局变量使用$g_开头,如$g_data_list. 1.1.2 一般变量 一般的变量使用小写字母命名,单词之间使用下划线分隔. 变量名字应该使用名词或者形容词+名词的方式.如$val

PHP的PSR规范中文版_php基础

文档仓库地址:https://github.com/hfcorriez/fig-standards PSR规范中文版 PSR-0自动加载 PSR-1基本代码规范 PSR-2代码样式 PSR-3日志接口 为何规范 摘录翻译了官方的一句话 本组织旨在通过讨论我们代码项目的共同点以找出一个协作编程的方法. 在此想到了一篇文章<Google为何要执行严格的代码规范>中有这么一段话: 复制代码 代码如下: 在谷歌,我可以查看任何的代码,进入所有谷歌的代码库,我有权查看它们.事实上,这种权限是很少人能拥有

php 目录与文件处理-郑阿奇(续)_php基础

1.文件目录操作 最顶层止录是磁盘根目录,用'/'或'//' 当前目录 ./ ../表示apache的目录即htdocs目录 1.创建与删除目录 mkdir 复制代码 代码如下: <?php if(mkdir("./path",0700)) //在当前目录中创建path目录 echo "创建成功"; ?> 2.获取和更改当前目录 使用getcwd()函数可以取得当前的工作目录,该函数没有参数.成功则返回当前的工作目录,失败则返回FALSE 3.打开和关闭

PHP基础学习小结_php基础

词法结构 1. 大小写 在PHP中,关键字.函数名以及类名不区分大小写,但变量名是区分大小写的. 2. 分号.空格.换行.大括号 在PHP中,分号表示一个语句的结束. 一般来说,空格和换行在PHP中没有实际意义,但可以提高代码的可读性. 大括号表示一个语句块. 3. 注释 PHP支持多种注释方式.如Shell注释方式(以#开头).C语言注释方式(以/*开头,以*/结尾).C++语言注释方式(以//开头).如: 12345 # Shell注释方式 /* C语言注释方式 */ // C++语言注释方

php读取本地文件常用函数(fopen与file_get_contents)_php基础

下面我们以.txt文件为实例来介绍php读取本地文件的函数,读取文件我们可以利用fopen或file_get_contents来读取,file_get_contents更简单而fopen需要fread配合才可以显示读出的内容. 1.首先来介绍一下fopen()函数 下面我们给出了一个直接打开本地文件的代码demo,必要的地方我们都已经加上了注释: 复制代码 代码如下:     //直接打开一个本地文件的实例代码       <?php       //假若我们本地的文件是一个名为xmlas.tx

《PHP编程最快明白》第八讲:php启发和小结_php基础

同时,有很多函数是可以有多种方法实现的,这需要灵活运用.只有记住了这些函数,才能开发出动态的网站:也只有多练习,整个网站开发一次,才能熟练的进行下次的开发,才发现自己的不足并改进. 很多方法都可以改进,比如这个计数器: 实例24 计数器 复制代码 代码如下: <?php //计数器 function countx($file="count.dat"){ if(file_exists($file)){ $fp=fopen($file,"r"); $numx=fg