the comment of zend develepment environment

最新推荐文章于 2021-03-04 21:14:05 发布

book2016

最新推荐文章于 2021-03-04 21:14:05 发布

阅读量685

点赞数

分类专栏： php 文章标签： zend phpdoc 文档 constructor class debugging

php 专栏收录该内容

63 篇文章

订阅专栏

本文介绍PHPDoc注释的使用方法，包括文档注释与非文档注释的区别、如何正确书写文档注释等内容，并通过示例展示了注释在API文档生成中的作用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

zend下面的注释
/**[Enter]就出来了。
而且你连打[Enter]行前自动加*。

  /**
   * Enter description here...
   *
   * @var unknown_type
   */

////////////////////////////////////
注释在PHPDoc中分为文档注释和非文档注释
　　
　　3.1 文档注释
　　文档注释实际上是一些特殊形式的多行注释，一般是放在你需要注释的特定的关键字(这些关键字是指将会被phpdoc分析的那些关键字，相关的关键字列表请参看后面第4节的说明）前面。下面是一个文档注释的例子：
　　/**
　　 * Common base class of all phpdoc classes （简述，用在索引列表中）
　　 *
　　 * As a kind of common base class PhpdocObject holds
　　 * configuration values (e.g. error handling) and debugging
　　 * methods (e.g. introspection()). It does not have a constructor,
　　 * so you can always inheritig Phpdoc classes from this
　　 * class without any trouble. （详细的功能描述）
　　 *
　　 * @author　 Ulf Wendel
　　 * @version　$Id: PhpdocObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $
　　 * @package　PHPDoc （文档标记）
　　 */
　　class PhpdocObject {
　　.....
　　}
　　
　　以上的文档注释将会生成如下的文档：
　　PhpdocObject
　　
　　PhpdocObject
　　
　　Common base class of all phpdoc classes
　　
　　private class PhpdocObject
　　
　　Common base class of all phpdoc classes
　　As a kind of common base class PhpdocObject holdsconfiguration values (e.g. error
　　handling) and debuggingmethods (e.g. introspection()). It does not have a
　　constructor,so you can always inheritig Phpdoc classes from thisclass without any trouble.
　　
　　Authors Ulf Wendel
　　Version $Id: PhpdocObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $
3.2 非文档性注释
　　如果你的注释没有放在那些phpdoc指定的关键字前面，那么phpdoc认为你所作的这些注释是属于非文档注释，将不会被phpdoc所分析，也不会出现在你产生的api文当中。
　　
　　3.3 如何书写你的文档性注释
　　从3.1 我们可以看到，一个文档性的注释，是由3个部分组成的，分别是：功能简述区，功能详细说明区，文档标记区。
　　
　　首先，第一行是一个注释开始的标志"/**"，然后是回车，从第2行开始就是功能简述区，功能简述区是以缩进的"*"开始的，在简述的正文和这个"*" 号之间用空格分隔（注意，在文档中，都是以*开始，并且这些*保持对齐的缩进格式）。功能简述的正文一般是简明扼要地说明这个类，方法或者函数的功能，功能简述的正文在生成的文档中将显示在索引区。
/////////////////////////////////////////////////////////////////
zend->工具->phpdocumenter生成所有类及注释文档