php 注释规范

高洛峰
发布: 2016-12-01 09:42:36
原创
1197人浏览过

@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.php1.cn/">可以写作 @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} 
显示一段函数或方法的内容

牛NIUCMS本地O2O系统
牛NIUCMS本地O2O系统

牛NIUCMS本地O2O系统是一个以php+mysql进行开发的o2o网站系统。NIUCMS是一款强大的网站管理系统。支持智慧城市、智慧小区、智慧乡村、本地生活门户、本地O2O平台的构建。请注意以下几点:1、这套源码必须要服务器支持伪静态,是支持.htaccess规则的伪静态,一般Apache服务器支持,别搞的下载回去以后说什么缺 少文件,其实源码并非缺少文件。2、这套源码请在php 5.4环境下

牛NIUCMS本地O2O系统 0
查看详情 牛NIUCMS本地O2O系统
相关标签:
php
PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号