PhpDocumentor标记使用说明
这里是标记的说明。使用说明可以参考这里http://blog.phpmore.com/index.php?op=ViewArticle&articleId=10&blogId=1
从手册里摘录翻译的一部分,算是个简单的参考吧
其实理解phpdoc的最好方法就是写一个文件,不断地加Tag,把各种Tag的效果都测试一下,就明白了。等我稍微有空了,会来做这个工作的。\r
PhpDocumentor标记使用说明
-
EasyChen 03/24/2005
整理自 手册
1 DocBlock
—————\r
在PhpDocumentor( phpdoc for short )中,可以被phpdoc识别的部分被看成一个DocBlock。\r
/**
* 一个简单的DocBlock
*/
希望phpdoc提取的文档,都需要放到这样的标记里边。\r
2 page-level DocBlock
————————-
文件开始的第一个元素且包含有@package标记的DocBlock,包含有相同@package标记的文件的文档将被组织到一个包。同样的,可以使用@subpackage来组织同一个package里边的文件。\r
更多的Tag可以参见phpdoc手册:\r
/**
* Page-level DocBlock
* @package pagepackage
*/
3 define语句 经常使用的标记\r
——————————\r
@name - 为一个变量指定别名\r
4 函数声明 经常使用的标记\r
——————————\r
@global - 全局变量
@param - 参数
@return - 返回值\r
@staticvar - 静态变量\r
inline {@source} - 显示DocBlock对应的源代码
5 全局变量定义 经常使用的标记\r
——————————\r
@name - 为一个变量指定别名\r
6 Class 元素 经常使用的标记\r
——————————\r
@package - 包\r
@subpackage - 子包
@static - 是否为静态\r
7 tag标记的继承\r
—————–\r
@author, @version 和 @copyright标记将自动继承除非在DocBlock中显示声明。\r
由于前期版本中@package和@subpackage也将被自动继承,建议为每个class显示指定@package和@subpackage标签以避免冲突。\r
如果子类没有短描述,父类的短描述将被继承。\r
如果子类没有长描述,父类的长描述将被继承。\r
如果已经有了长描述,你还希望继承父类的描述,用inline {@inheritdoc}标签。\r
8 类中属性 经常使用的标记\r
————————–\r
@var - 属性\r
9 类中方法 经常使用的标记\r
————————–\r
@global - 全局变量
@param - 参数
@return - 返回值\r
@static - 该方法是否为静态\r
@staticvar - 静态变量\r
inline {@source} - 显示DocBlock对应的源代码
PHP单元测试工具:SimpleTest
Wednesday, December 22nd, 2004发表在php&more vol2上的文章,转载请保留署名,保持一致,注明出处。EasyChen.
陌生却熟悉的Unit Test
?
对PHP开发者来说,单元测试这个名词也许有些陌生,但是实际上我们却常常在自发的进行着单元测试。\r
?
如果你和Easy一样,总是一边添加代码一边不断地在刷新着页面,那么,单元测试早已融入了你的开发中。是的,单元测试其实就是通过尽可能早尽可能 快的进行测试来把错误扼杀在摇篮中的,不过使用的,是自动化的工具。根据TDD(测试驱动开发)的思想,我们在一个功能开始之前就可以创建它的测试代码, 然后通过不断的测试、和添加功能来不断的完善它,在这个过程中,我们对需求和编码的理解会变得更为深入。\r
?
PHP开发者的单元测试工具包
?
在PHP领域,单元测试的工具主要有PHPUNIT,PHPUNIT2和SimpleTest三种。其中PHPUNIT在功能上很简单,不算完善; PHPUNIT2是专门为PHP5写的单元测试工具,在结构和功能上都向Junit看齐;而SimpleTest则是一套非常实用的测试工具,其中的 webTest支持对web程序界面的测试,是Easy最为推荐的一款测试工具。在本文中,我们选择SimpleTest进行介绍。\r
?