php 参数注释-php教程-PHP中文網

首頁

後端開發

php教程

php 参数注释

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Jun 23, 2016 pm 02:30 PM

简介：这是php 参数注释的详细页面，介绍了和php,有关的知识、技巧、经验，和一些php源码等。

class='pingjiaF' frameborder='0' src='http://biancheng.dnbcw.info/pingjia.php?id=340853' scrolling='no'>

所有的文档性注释都是由/**开始的一个多行注释，在phpDocumentor里称为DocBlock, DocBlock是指软件开发人员编写的关于某个关键字的帮助信息，使得其他人能够通过它知道这个关键字的具体用途，如何使用。 PhpDocumentor规定一个DocBlock包含如下信息： 1. 功能简述区 2. 详细说明区 3. 标记tag 文档性注释的第一行是功能描述区，正文一般是简明扼要地说明这个类，方法或者函数的功能，功能简述的正文在生成的文档中将显示在索引区。功能描述区的内容可以通过一个空行或者 . 来结束 在功能描述区后是一个空行，接着是详细说明区,. 这部分主要是详细说明你的API的功能，用途，如果可能，也可以有用法举例等等。在这部分，你应该着重阐明你的API函数或者方法的通常的用途，用法，并且指明是否是跨平台的（如果涉及到），对于和平台相关的信息，你要和那些通用的信息区别对待，通常的做法是另起一行，然后写出在某个特定平台上的注意事项或者是特别的信息，这些信息应该足够，以便你的读者能够编写相应的测试信息，比如边界条件，参数范围，断点等等。 之后同样是一个空白行，然后是文档的标记tag，指明一些技术上的信息，主要是最主要的是调用参数类型，返回值极其类型，继承关系，相关方法/函数等等。 关于文档标记，详细的请参考第四节:文档标记。 文档注释中还可以使用例如 这样的标签，详细介绍请参考附录二。 下面是一个文档注释的例子

/** * 函数add,实现两个数的加法 * * 一个简单的加法计算，函数接受两个数a、b，返回他们的和c * * @param int 加数 * @param int 被加数 * @return integer */ function Add($a, $b) { return $a+$b; }

生成文档如下： Add integer Add( int $a, int $b) [line 45] 函数add,实现两个数的加法 Constants 一个简单的加法计算，函数接受两个数a、b，返回他们的和c Parameters ? int $a - 加数 ? int $b - 被加数 5．文档标记： 文档标记的使用范围是指该标记可以用来修饰的关键字，或其他文档标记。 所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。 @access 使用范围：class,function,var,define,module 该标记用于指明关键字的存取权限：private、public或proteced @author 指明作者 @copyright 使用范围：class，function，var，defi

使用范围：define 用来指明php中define的常量 @final 使用范围：class,function,var 指明关键字是一个最终的类、方法、属性，禁止派生、修改。 @filesource 和example类似，只不过该标记将直接读取当前解析的php文件的内容并显示。 @global 指明在此函数中引用的全局变量 @ingore 用于在文档中忽略指定的关键字 @license 相当于html标签中的,首先是URL，接着是要显示的内容 例如百度 可以写作 @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} 显示一段函数或方法的内容 6．一些注释规范 a.注释必须是 /** * XXXXXXX */ 的形式 b.对于引用了全局变量的函数，必须使用glboal标记。 c.对于变量，必须用var标记其类型（int,string,bool...） d.函数必须通过param和return标记指明其参数和返回值 e.对于出现两次或两次以上的关键字，要通过ingore忽略掉多余的，只保留一个即可 f.调用了其他函数或类的地方，要使用link或其他标记链接到相应的部分，便于文档的阅读。 g.必要的地方使用非文档性注释，提高代码易读性。 h.描述性内容尽量简明扼要，尽可能使用短语而非句子。 i.全局变量，静态变量和常量必须用相应标记说明 7. 总结 phpDocumentor是一个非常强大的文档自动生成工具，利用它可以帮助我们编写规范的注释，生成易于理解，结构清晰的文档，对我们的代码升级，维护,移交等都有非常大的帮助。 关于phpDocumentor更为详细的说明，可以到它的官方网站 http://manual.phpdoc.org/查阅 8．附录 附录1: 能够被phpdoc识别的关键字： Include Require include_once require_once define function global class 附录2 文档中可以使用的标签  <kdb> <li> <pre class="brush:php;toolbar:false"> </pre> <ul> <samp> <var> 附录三： 一段含有规范注释的php代码 :</var></samp> </ul> </li></kdb>

<?php/*** Sample File 2, phpDocumentor Quickstart** This file demonstrates the rich information that can be included in* in-code documentation through DocBlocks and tags.* @author Greg Beaver <cellog@php.net>* @version 1.0* @package sample*/// sample file #1/*** Dummy include value, to demonstrate the parsing power of phpDocumentor*/include_once 'sample3.php';/*** Special global variable declaration DocBlock* @global integer $GLOBALS['_myvar']* @name $_myvar*/$GLOBALS['_myvar'] = 6;/*** Constants*//*** first constant*/define('testing', 6);/*** second constant*/define('anotherconstant', strlen('hello'));/*** A sample function docblock* @global string document the fact that this function uses $_myvar* @staticvar integer $staticvar this is actually what is returned* @param string $param1 name to declare* @param string $param2 value of the name* @return integer*/function firstFunc($param1, $param2 = 'optional') {/*** A sample private variable, this can be hidden with the --parseprivate* option* @accessprivate* @var integer|string*/var $firstvar = 6;/*** @link http://www.example.com Example link* @see myclass()* @uses testing, anotherconstant* @var array*/var $secondvar =array(    'stuff' =>                 array(                                   6,                                   17,                                   'armadillo'                           ),     testing => anotherconstant);/*** Constructor sets up {@link $firstvar}*/function myclass() {$this->firstvar = 7;}/*** Return a thingie based on $paramie* @param boolean $paramie* @return integer|babyclass*/function parentfunc($paramie) {if ($paramie) {return 6;} else {return new babyclass;}}}/*** @package sample1*/class babyclass extends myclass {/*** The answer to Life, the Universe and Everything* @var integer*/var $secondvar = 42;/*** Configuration values* @var array*/var $thirdvar;/*** Calls parent constructor, then increments {@link $firstvar}*/function babyclass() {parent::myclass();$this->firstvar++;}/*** This always returns a myclass* @param ignored $paramie* @return myclass*/function parentfunc($paramie) {return new myclass;}}?>

爱J2EE关注Java迈克尔杰克逊视频站JSON在线工具

http://biancheng.dnbcw.info/php/340853.html pageNo:6

陳述

本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn

PHP和Python：解釋了不同的範例Apr 18, 2025 am 12:26 AM

PHP主要是過程式編程，但也支持面向對象編程（OOP）；Python支持多種範式，包括OOP、函數式和過程式編程。 PHP適合web開發，Python適用於多種應用，如數據分析和機器學習。

PHP和Python：深入了解他們的歷史Apr 18, 2025 am 12:25 AM

PHP起源於1994年，由RasmusLerdorf開發，最初用於跟踪網站訪問者，逐漸演變為服務器端腳本語言，廣泛應用於網頁開發。 Python由GuidovanRossum於1980年代末開發，1991年首次發布，強調代碼可讀性和簡潔性，適用於科學計算、數據分析等領域。

在PHP和Python之間進行選擇：指南Apr 18, 2025 am 12:24 AM

PHP適合網頁開發和快速原型開發，Python適用於數據科學和機器學習。 1.PHP用於動態網頁開發，語法簡單，適合快速開發。 2.Python語法簡潔，適用於多領域，庫生態系統強大。

PHP和框架：現代化語言Apr 18, 2025 am 12:14 AM

PHP在現代化進程中仍然重要，因為它支持大量網站和應用，並通過框架適應開發需求。 1.PHP7提升了性能並引入了新功能。 2.現代框架如Laravel、Symfony和CodeIgniter簡化開發，提高代碼質量。 3.性能優化和最佳實踐進一步提升應用效率。

PHP的影響：網絡開發及以後Apr 18, 2025 am 12:10 AM

PHPhassignificantlyimpactedwebdevelopmentandextendsbeyondit.1)ItpowersmajorplatformslikeWordPressandexcelsindatabaseinteractions.2)PHP'sadaptabilityallowsittoscaleforlargeapplicationsusingframeworkslikeLaravel.3)Beyondweb,PHPisusedincommand-linescrip

PHP類型提示如何起作用，包括標量類型，返回類型，聯合類型和無效類型？Apr 17, 2025 am 12:25 AM

PHP類型提示提升代碼質量和可讀性。 1)標量類型提示：自PHP7.0起，允許在函數參數中指定基本數據類型，如int、float等。 2)返回類型提示：確保函數返回值類型的一致性。 3)聯合類型提示：自PHP8.0起，允許在函數參數或返回值中指定多個類型。 4)可空類型提示：允許包含null值，處理可能返回空值的函數。

PHP如何處理對象克隆（克隆關鍵字）和__clone魔法方法？Apr 17, 2025 am 12:24 AM

PHP中使用clone關鍵字創建對象副本，並通過\_\_clone魔法方法定制克隆行為。 1.使用clone關鍵字進行淺拷貝，克隆對象的屬性但不克隆對象屬性內的對象。 2.通過\_\_clone方法可以深拷貝嵌套對象，避免淺拷貝問題。 3.注意避免克隆中的循環引用和性能問題，優化克隆操作以提高效率。