问题标签 [phpdoc]

根据 PhpDocumntor 的说法，为了转换成有效的文档，每个注释块都需要像这样封装：

您是否知道是否有可能（可能通过更改某些设置）以避免被迫在每行前面放置一个星号。我基本上希望 PhpDocumentor 接受这些类型的评论并将其翻译成文档：

我问是因为JsDOC 和 JavaDoc 不再需要在每个新行前面加上该死的星号了，所以我想也许 PhpDocumentor 也可以通过欺骗它的设置来做到这一点，但我在 Google 上找不到任何相关信息.

我有一个函数，它（例如）在允许访问时返回 true，在拒绝访问时返回 false，在访问不确定时返回 NULL。

@returnphpdoc应该是什么？bool似乎没有意义...

如何记录 phpDoc 的类常量？我已经阅读了手册，但我找不到任何关于它们的信息。

如果一个函数依赖，$_SESSION['some_var']那么标头注释会清楚地表明这一点。你怎么做呢？就像文本一样，还是什么？

甚至@param？

我正在尝试了解 phpDocumentor。我通常为每个文件放置一个类。我是否被迫记录文件和课程？我只想记录类（为什么要记录文件？）但我收到警告...

我已阅读http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html。

谢谢

我知道 PHPDoc 存在，但phpdoc希望您在 PHP 文件中添加注释，以便它可以解析它们...

我想要的是不同的东西：假设我有 10 个 PHP 类......我想要的只是一个可以读取这些类并自动生成这些类结构的表示的脚本，即它们中有哪些类、属性、方法等，并以易于遵循的格式组织该信息...

你们中有人知道自动执行此操作的任何脚本吗？

我参考CSSDoc规范并希望从 css 文件生成注释文档。第一个想法是使用phpdocumentor工具。执行phpdoc -o HTML:frames:default -f main.css -t docs命令时，我收到“文件未解析，不是 php 文件”错误消息。请告诉我如何通过自动文档工具从 css 文件生成文档。应该使用 Doxygen、JavaDoc 工具或使用现有工具编写新的解析器。谢谢~~~~

我正在使用Symfony Event Dispatcher在我们的应用程序中实现一个事件调度系统。管理员可以启用或启用一系列模块，中央注册表将自动注册插件感兴趣的事件并处理事件的调度。

我们目前使用 PHPDoc 来生成我们所有的文档，并有一个严格的 PHP Codesniffer 标准来确保文档的完整性和一致性。

我想要做的是自动生成文档，在一个地方列出系统中可用的所有事件；我想通过轻松找出可用的事件、这些事件中提供的数据以及可以随事件发送的响应来轻松开发新插件。

有没有办法使用 PHPDoc 来实现这一点？到目前为止，我最好的方法是在通知事件的方法中添加一个 @uses 标签，引用我的 PluginRegistry 类；这样至少可以找到相关的方法，但它远远不够理想，因为它没有提供额外的文档（什么事件可用，什么数据，什么返回数据，甚至方法中有多少事件）。

我知道这可以说不是与编程相关的问题，但由于我们是程序员，我们可能会使用 Netbeans 进行 PHP 开发。

我想知道在更改参数集后如何在 Netbeans 中更新方法前面的注释块。我需要以某种方式自动更新它，并保留我之前添加的内容。

假设我在方法中添加了 10 个以上的参数，并且我希望它出现在之前的评论部分（PHPdoc），我如何更新评论部分？

我正在使用PHPdocumentor记录我的 CakePHP 应用程序。您可能知道，在 CakePHP 约定之后，视图包含在 .ctp 文件中（例如 app/views/addresses/index.ctp），这些文件基本上是普通的 PHP 文件，只是更改了文件扩展名。PHPdocumentor 只识别 .php 文件，我无法在配置文件中找到一个选项来让它知道 .ctp 文件。这部分最接近我想要的：

但它似乎不接受通配符*.php，我真的不想将我的 50 个视图文件的列表写入这个配置文件（除非有更好的解决方案）。是否有可能在全局范围内配置 phpdoc 以包含 .ctp 文件，或者我是否必须在 phpdoc 源代码中的某个地方更改它？