2013-08-01 57 views
0

我在开始使用phpdoc时遇到问题。 我创建了一个示例php文件。这是代码:phpdoc入门问题

<?php 
/** 
* short comment 
*/ 

/** This is the 
* longer comment 
*/ 

/** 
* @author My Name <[email protected]> 
*/ 
    echo "Hello, World"; 
?> 

据我了解这一点,我现在应该能够使这个代码的文档使用下面的命令:

phpdoc project:run -f C:\xampp\htdocs\libs\test.php -t C:\phpdoc\ 

的test.php的文件是我粘贴在这里的文件。 C:\ phpdoc \是应该放置文档的位置。现在,当我去那里时,生成了几个文件和文件夹,但是当我打开“index.php”文件并单击“Global()”时,我的窗口看起来如下:

[I would have a Image在这里,但我的声誉是低的。我试图描述它看起来如何:它看起来像一个无效的路径到CSS文件的网页。所有图像和自定义按钮都丢失,字体只是常规时间的新罗马字体。没有背景图片等]

这是为什么?我究竟做错了什么?

BTW:我使用Windows 7 x64和XAMPP

的新版本(也新安装)

阅读

回答

0

我用apigen做我的PHP文档块最好的问候和感谢由我去推测phpdoc的工作原理是一样的。你想要做的就是把所有这些成一个单一的块,像这样的内容:

/** 
* Short description, keep to one line. 
* 
* Long description, you can break this up 
* over multiple lines. 
* 
* @author [email protected] 
* @param incoming The variable that is being sent in 
* @return bool Type of variable to return and explanation of return value 
*/ 
public function doStuff($incoming) { 
    //Do stuff here 
    return true; 
} 

你可以把上面的那些函数,变量,类。通常,您为文件创建的第一个docblock将成为整个文件的docblock。

+0

嗨! 谢谢你的回答! 不幸的是我已经尝试过,并没有改变任何结果。 – Christian

+0

@ user2399808就docblock而言,这就是我用于apigen的东西。对于phpdoc可能会有所不同,但我不明白他们为什么会将块拆分成更小的块。对于另一个关于丢失图像的问题,Windows 7中的UAC可能会因为您正在写入硬盘的根目录而陷入困境,假设C:是您的Windows安装位置。我会把你的输出目录移到别的地方(比如在C:\ xampp \ htdocs \ libs \ phpdoc \中)或者在管理模式下运行你的cmd,这样phpdoc不会受到任何权限问题的阻碍。 – Crackertastic