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”文件并单击“Global ()”时，我的窗口如下所示：

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

这是为什么呢？我做错了什么？

顺便说一句：我使用的是 Windows 7 x64 和 XAMPP 的新版本（也是新安装的）

致以诚挚的问候，非常感谢您的阅读

Answer 1

我使用 apigen 来做我的 php docblocks，因为我猜测 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;
}

你可以放置上面那些函数、变量、类。通常，您为文件创建的第一个 docblock 会成为整个文件的 docblock。