没看懂,如果你们看懂了请告诉我。传送门

3、以”/*”和”*/”闭合的多行注释符。

截止2016.10.1日,phpdocmentor只有2.9.0支持php7

作者格式@author [名称] []例如@author mokeyjay

详细解释如下:

基本使用方法

phpdoc -d [目录位置] -t [输出位置]     #输出位置可选

如需API手册,可使用phpDocumentor来自动生成

@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} 
显示一段函数或方法的内容

docblock注释

多行注释风格

 <?php
 /**
  * A summary informing the user what the associated element does.
  *
  * A *description*, that can span multiple lines, to go _in-depth_ into the details of this element
  * and to provide some background information or textual references.
  *
  * @param string $myArgument With a *description* of this argument, these may also
  *    span multiple lines.
  *
  * @return void
  */
  function myFunction($myArgument)
  {
  }
  • summary简要介绍
    需要以.(dot)然后紧跟一个空行结束

  • description简要描述
    遇到*/或者tag结束

  • tag标签
    以@开头的一些有意义标签

类属性,与@method类似,可以告诉IDE我这类里有哪些属性格式@property
[Type] [name] []例如@property int id 用户id

1、以”#”开始的单行注释符;

内联标签(inline tags)

常规标签不同,行内标签不要求出现在新行的开头,而可以出现在文本流中

Syntax
@link [URI] [<description>]
or inline
{@link [URI] [<description>]}

只可写的属性。例如__set魔术方法能够设置的属性格式@property-write
[Type] [name] []例如@property-write string name 用户名

php常用注释有三种:

常规标签

  • @package
    描述class所属的namespace

  • @access
    public, private or protected

  • @author
    作者信息:

    `@author    jcuan <heheda@heheda.com>`
    
  • @copyright
    文档版权信息

     @copyright Copyright (c) 2014 - 2016, British Columbia Institute of Technology (http://bcit.ca/)
    
  • @deprecated
    以后将被废除的方法

/**
 * @deprecated
 * @deprecated 1.0.0
 * @deprecated No longer used by internal code and not recommended.
 * @deprecated 1.0.0 No longer used by internal code and not recommended.
 */
 function count()
 {
     <...>
 }
  • throws
    @throws [Type] [<description>]

 /**
  * Counts the number of items in the provided array.
  *
  * @param mixed[] $array Array structure to count the elements of.
  *
  * @throws InvalidArgumentException if the provided argument is not of type
  *     'array'.
  *
  * @return int Returns the number of elements.
  */
 function count($items)
 {
     <...>
 }
  • @license
    @license [<url>] [name]

 /**
  * @license GPL
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  */
  • @method
    用在使用了__call()魔术方法的类
    @method [return type] [name]([[type] [parameter]<, ...>]) [<description>]

 class Parent
 {
     public function __call()
     {
         <...>
     }
 }

 /**
  * @method string getString()
  * @method void setInteger(integer $integer)
  * @method setString(integer $integer)
  */
 class Child extends Parent
 {
     <...>
 }
  • @param
    函数参数描述@param [Type] [name] [<description>]

 /**
  * Counts the number of items in the provided array.
  *
  * @param mixed[] $items Array structure to count the elements of.
  *
  * @return int Returns the number of elements.
  */
 function count(array $items)
 {
     <...>
 }
  • @return
    @return [Type] [<description>]

  • @see
    网址或其他方法的引用
    @see [URI | FQSEN] [<description>]

/**
  * @see http://example.com/my/bar Documentation of Foo.
  * @see MyClass::$items           For the property whose items are counted.
  * @see MyClass::setItems()       To set the items for this collection.
  *
  * @return integer Indicates the number of items.
  */
 function count()
 {
     <...>
 }
  • @since
    本方法从哪个版本开始出现
    @since [version] [<description>]

  • @todo
    接下来要做的
    @todo [description]

  • @var
    函数变量
    @var [“Type”] [$element_name] [<description>]

class Foo
{
  /**
   * @var string $name        Should contain a description
   * @var string $description Should contain a description
   */
  protected $name, $description;
}
  • @version
    当前版本
    @version [<vector>] [<description>]

看得多了就大概知道了一些规律。为了使自己的代码更加规zhuang范bi,也开始有样学样地写着这些注释

常用的php注释规范小结如下:

文档级别的注释

<?php
/**
 * I belong to a file
 */

/**
 * I belong to a class
 */
class Def
{
}

下边是属于类的注释

<?php
/**
 * I belong to a class
 */

class Def
{
}

PHPDOC

/**
*爆大奖永利官网765me, @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设置
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/

可能会抛出的错误类型格式@throws [类型] []例如@throws LifeException
没钱了,好想死啊

2、以”//”开始的单行注释符;

让你的代码更加规zhuang范bi,更易于理解

PHPDoc 是一个 PHP 版的 Javadoc。它是一种注释 PHP
代码的正式标准。它支持通过类似 phpDocumentor 这样的外部文档生成器生成
API 文档,也可以帮助一些例如 Zend Studio, NetBeans, ActiveState Komodo
Edit and IDE 和 Aptana Studio 之类的 集成开发环境
理解变量类型和弱类型语言中的其他歧义并提供改进的代码完成,类型提示和除错功能。PHPDoc
可同时支持 面向对象 的和 面向过程的 代码。

参数,用于函数和方法注释里的标记格式@param [Type] [name]
[]例如@param string title 文章标题

@author

还等什么?快跟我一起来学习又好用又有逼格的phpDoc吧!

让你的IDE更懂你的代码,更加智能的提示和自动完成

@property

变量格式@var [类型] [变量名] []例如@var int id 用户id

参考,类似@link,可与@deprecated联动格式@see [url或完整方法名]
[]例如@see yiibasedb::tableName()
旧方法table_name已弃用,请使用此方法替代

忽略格式@ignore
[]例如你在if和else的语句块中定义分别同一个变量但值不同时,可以通过此标记让phpDocumentor忽略其中一个,以免生成重复的文档。例如

@example

全局变量格式@global [类型][名称] @global
[类型][描述]我怀疑这里是源文档打错了,大概应该是格式@global
[类型][名称][描述]类型@global string name 用户名

@deprecated

@global

发表评论

电子邮件地址不会被公开。 必填项已用*标注