phpdoc入门问题

Question

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

<?php
/**
*   short comment
*/

/** This is the
*   longer comment
*/

/** 
* @author My Name <my.name@example.com>
*/
    echo "Hello, World";
?>

据我所知，我现在应该能够使用以下命令创建此代码的文档：

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

test.php文件就是我粘贴到这里的文件。C:\phpdoc\是应该放置文档的位置。现在，当我转到那里时，会生成几个文件和文件夹，但当我打开"index.php“文件并单击”全局()“时，我的窗口看起来如下所示：

我会在这里放置一个图像，但我的声誉太低了。我正在尝试描述它的外观:它看起来像是一个带有无效css文件路径的网页。所有的图像和自定义按钮都丢失了，字体只是常规的新罗马字体。没有背景图像等

为什么会这样呢？我做错了什么？

顺便说一下:我使用的是Windows7 x64和一个新版本(也是新安装的)的XAMPP

致以最诚意的问候和非常感谢您的阅读

Answer 1

我使用apigen来做我的php docblock，我会猜测phpdoc也是一样的。您要做的是将所有这些内容放入一个块中，如下所示：

/**
 * Short description, keep to one line.
 * 
 * Long description, you can break this up
 * over multiple lines.
 * 
 * @author your.name@yourplace.com
 * @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;
}

你可以把它们放在函数，变量，类上面。通常，您为文件创建的第一个文档块将成为整个文件的文档块。