问题标签 [phpdocumentor2]

我正在将 PHP 文档与我的产品集成，因为我计划允许用户更改插件中的各种内容。

到目前为止一切顺利，我的目录中有 phpdoc .phar，我可以解析 html 文件。但我有两个问题：

1 - 我不知道如何准确地使用@example 标签，

这是我的代码：

当我检查 phpdoc 时，它显示如下：

我不确定为什么它说找不到文件，但我在网上找不到使用此标签的示例，我希望它会在我的使用示例中显示一个小代码框。

2 - 如何解决找不到文件的问题？

类文件路径是oop/admin/class-wcdpue-admin.php，我尝试将 doc 块更改为：

我正在运行的 phpdoc 命令是：php phpDocumentor.phar -d oop/ -t docs/api --sourcecode如果有任何帮助，由于某种原因，我也无法从渲染的 phpdoc 中看到我定义的任何块的源代码：

任何帮助表示赞赏

我有一个 CodeIgniter 项目，其中包含许多模块和代码。

现在我想为其他新同事创建文档。

例如

我已经使用了以下命令

一、PHPdoc

二、ApiGen

是否可以在代码生成之前或之后向模块添加注释？因为我希望在文档本身中为特定模块添加注释，并且可以选择在正确的位置自动插入到源代码中。

我应该如何管理项目中的模块和代码以及如何创建可浏览的 HTML 文档？

任何其他可以直接从您的 PHP 源代码生成文档的工具，这将是很好的建议

假设我在我的包 ServiceProvider 中注册了一个宏，并且我正在为我的包编写文档。

现在如何$this在Closure中记录变量？

我正在将我的项目升级到 PHP 8.0+。到目前为止，在代码注释中，我使用了"option 1"@param中的and@return标签，而不是"option 2"中的标签：

选项1：

• @param string[] ....
• @return User[] ....

选项 2：

• @param array ....
• @return array ....

不过，因为我不知道第一种形式是否被官方允许，所以我开始问自己，切换到第二种选择会不会更好......所以，我想问你：有没有任何用于记录 PHP 代码的官方PHPDoc 参考资料？

另外，是否建议使用第一个选项而不是第二个选项？换句话说：是否有任何反对它的论据——也考虑到未来？

感谢您的时间。

PS：我找到了PHPDocumentor的参考资料，但我有一种感觉，它不是官方的 PHP 文档，而且（还）不兼容 PHP 8.0+。

我是 phpDocumentor 的新手，尽管我过去曾广泛使用过 JavaDoc。

首先，我创建了以下测试文件a.php：

然后我使用以下命令行运行phpDocumentor v3.0.0 ：

生成的文档存在以下问题 - 请参阅此处的屏幕截图：

1. 生成的 HTML 中既不存在文件级注释，也不存在全局变量 $var。
2. 对于常量 DO_IT，缺少默认值的第一个字母（'alse'）。

知道我做错了什么吗？谢谢！

我正在尝试使用 phpDocumentor 生成我的 Laravel 包文档，但我发现生成面向使用的文档并不像我想的那样容易。

我的意思是：我应该如何编写 docblocks 以正确让 php 文档或生成我的模型文档？应该如何为 eloquent 和 laravel 的特定功能编写 docblock？

例如，目前在我的一个模型中，我使用@ignoreclass $timestamps、和properties 以及附加属性的所有访问器进行了标记，并使用标记在类级别添加了模型$fillable属性：$appends$casts@property

这会生成更简单的文档，因为它从如何使用模型的角度显示/解释模型。

范围和关系出现问题：我应该如何为这些（实际上）方法编写文档块？
关系通常用作属性，期望它们返回模型或集合，但如果需要添加条件并期望返回关系实例，则可以再次用作函数。
范围仍然用作函数，但使用不同的签名调用，因为第一个参数是从框架注入的，甚至名称也不同。

有没有关于这种情况的约定？

在查看 PHPDoc 和 PHPDocumenter 的在线文档时，有许多资源提供了如何使用它的详细信息。但是，其输出的任何示例都很少。通常只有一小部分 html 页面提供了一个想法。

是否有任何资源可以提供此类输出的实际示例，或者至少提供更完整的示例？