`
webcode
  • 浏览: 5985782 次
  • 性别: Icon_minigender_1
  • 来自: 上海
文章分类
社区版块
存档分类
最新评论

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,接着是要显示的内容
例如<ahref=”http://www.baidu.com”>百度</a>
可以写作@licensehttp://www.baidu.com百度
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名。
@package
使用范围:页面级别的->define,function,include
类级别的->class,var,methods
用于逻辑上将一个或几个关键字分到一组。
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的。
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常,极其发生的情况
上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inlinetag,用{@}表示,具体包括以下几种:
{@link}
用法同@link
{@source}
显示一段函数或方法的内容
分享到:
评论

相关推荐

    PHP Document 代码注释规范

    HPDocumentor是一个用PHP写的工具,对于有规范注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档。老的版本是 phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,...

    php 注释规范

    php 注释规范,学习php的朋友可以参考下

    Doxygen代码注释规范.docx

    Doxygen 代码注释规范 Doxygen 是一种开源跨平台的,以类似 JavaDoc 风格描述的文档系统,完全支持 C、C++、Java、Objective-C 和 IDL 语言,部分支持 PHP、C#。Doxygen 可以从一套归档源文件开始,生成 HTML 格式...

    php开发文档注释规范_规范_文档规范_开发规范_

    所有的文档标记都是在每一行的*后面以@开头。如果在一段话的中间出来@的标记,这个标记将会被当做普通内容而被忽略掉。 @access该标记用于指明关键字的存取权限:private、public或proteced使用范围:

    java代码注释规范文档

    后端开发技术的代码注释规范 单行注释 多行注释 块注释 文档注释 标签注释等等

    PHP文档规范及phpDoc指南-共享版

    《PHP文档规范及phpDoc指南-共享版》主要内容是介绍如何写PHP文档和注释,还有phpdoc的使用指南。 适用人群:PHP程序员、工程师、技术经理、架构师和技术总监

    swagger-php, php swagger注释和解析库.zip

    swagger-php, php swagger注释和解析库 swagger-php为你的RESTful API生成交互式的文档,使用 Doctrine 注释。特性Swagger 2.0规范兼容。异常错误报告( 带有提示,上下文)从代码&中提取现有的phpdoc注

    PHP编码规范 最新版

    最新最简单易用的PHP编码规范, 含文件目录命名规则, 含PHP代码规范, 含注释规范, 含常规设置规范一看即懂

    php编程规范与手册

    chm格式的文档 教会你如何使用PHP PHP手册分为 入门指引,安装与配置,语言参考,安全,特点,函数 等等 ...文件结构,文件名,源文件的编码规范,注释,声明,语句,空白,命名规范,编程惯例,代码示范

    PHP注释语法规范与命名规范详解篇

    HP注释规范 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 “php是一门及其容易入门的语言,刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello...

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

    PHP 注释标记 @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private、public或proteced @author 指明作者 @copyright 使用范围:class,function,var,define,module,...

    PHP程序编码标准规范.doc

    为了更好的提高开发的工作效率,保证开发的有效...本规范包含了PHP开发时程序编码中代码缩进规则、控制结构、函数调用、函数定义、注释、包含代码、PHP标记、文件头的注释块、CVS标记、URL样例、常量命名等方面的规则。

    PHP 编程规范详解

    PHP 编程规范 注释的规则 变量名的命名规则

    PHP开发规范_20120711V1r4-draft_quxianping_revision1

    以下是 PHP 开发规范中注释的要求: * 使用 // 或 # 开头的注释,例如 // 这是一个注释。 * 使用块注释,例如 /* 这是一个块注释 */。 * Avoid using unnecessary comments,例如 // 这是一个废弃的注释。 设计...

    vim-code-sniffer:vim 插件,生成适应 PHP_CodeSniffer 规范的注释

    vim-code-sniffervim 插件,生成适应 PHP_CodeSniffer 规范的注释,修改自Doxygen。安装可以通过配置vundle来安装,在 .vimrc 添加Plugin 'jixiaod/vim-code-sniffer':PluginInstall配置配置自己的注释信息,添加到....

Global site tag (gtag.js) - Google Analytics