/**
* 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 {
.....
}
以上的文档正文将会生成以下的文档:
<b>PhpdocObject</b>
PhpdocObject
Common base class of all phpdoc classes
<b>private class PhpdocObject </b>
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.
* @author Night Sailer <night@hotmail.com>
* @author Lee Tester <tester@gnome.org>
@brother (function()|$variable) 利用局限:class, function, var, define, module, use
@sister (function()|$variable) 利用局限:class, function, var, define, module, use
其次,你要修正phpdoc目次上面的index.php文件:
// Directory with include files
define("PHPDOC_INCLUDE_DIR", "c:/www/apache/doc/");
将"c:/www/apache/doc/修正成你的phpdoc的目次
// Important: set this to the Linebreak sign of your system!
define("LINEBREAK", "\r\n");
这是界说换行的标记,DOS上面是换行+回车,UNIX上面只是回车就能够。
上面,为你的要生成文档的使用法式做一些定制任务:
// Sets the name of your application.
// The name of the application is used e.g. as a page title
$doc->setApplication("PHPDoc");
setApplication()用来设置你的使用法式的称号,将PHPDOC交换成你使用法式的名字。
// directory where your source files reside:
$doc->setSourceDirectory(PHPDOC_INCLUDE_DIR);