我在开始使用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文件路径无效的网页。所有图像和自定义按钮都丢失了,字体只是普通的新罗马字体。没有背景图像等等]
为什么?我做错了什么?
BTW:我正在使用Windows 7 x64和XAMPP 的新版本(也是新安装的)
最良好的问候和非常感谢阅读
我使用apigen来完成我的php文档块,我将推测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;
}
您可以将这些放置在函数、变量和类之上。通常,为文件创建的第一个文档块将成为整个文件的文档块。