问题标签 [phpdoc]

是否有用于记录采用单个配置数组而不是单个参数的函数的语法？

我正在特别考虑 CodeIgniter 风格的库，它使用类似于以下的机制：

所以我的问题是，除了纯文本描述之外，是否有一些支持的方式来记录配置数组？实际上指定了一个@param [type] [name] [desc]允许 PHPDoc 解析出有用值的属性？

顺便说一句，CodeIgniter 确实只是用上面通过 $config 数组传入的值覆盖了它自己的值，从而有效地允许您破坏私有成员。我不是粉丝，但我坚持下去。

在 Aptana 中，我以某种方式破坏了为类中的函数自动生成 phpdoc 注释的功能。它似乎只影响我当前的项目。

通常我可以在函数前的行上键入 /** 并按回车键，Aptana 将使用正确的 @param 值创建一个 phpdoc 注释，等等。出于某种原因，当我现在这样做时，Aptana 会创建 2 个注释，一个在另一个. 例如

如果我尝试将其用于全局功能，它可以正常工作。它也适用于类变量和类本身。

真的有必要做这样的事情：

我有很多没有返回值的方法，在评论中放这样的东西似乎真的是多余的。将其排除在外会被认为是不好的形式吗？

如何在 Netbeans 中自动格式化 PhpDoc 注释？

我想让评论像这样排列：

当我输入 /**[Enter]Netbeans 时，它会自动@param从方法定义中导入所有参数。但是，当评论已经生成时，我会在定义中添加一个新变量。现在怎么办？如何触发评论重解析并添加新添加的参数？

在 PHP 项目中，即使在主应用程序使用前端控制器逻辑时，也可能存在许多独立脚本、ajax 片段等。

是否有一种标准化的方式——PHPDoc 或其他方式——在脚本的第一个注释块中定义脚本将接受/需要的 GET 和/或 POST 参数以及它们的类型？

我通常通过添加@params 来帮助自己，就好像文件是一个函数一样，并@return解释了脚本的作用和返回，但也许有一种我不知道的更专业的方法。

我通过 mamp 有 phpdoc。我按照他们的教程，在终端中输入了这个。

当然，我将 /path/to/document_root 更改为我的网络空间文件夹。

但是然后呢？如何通过 web 界面访问 phpdoc？

第一天我使用phpDocumentor到目前为止一切都很好，但是我有一个问题，我没有在手册中找到......全局变量的文档。

如果出现以下情况，我将如何记录此代码：

1. $someGlobalVar不是类的 PHP 文件中的 decalren（它甚至可以是 unelared）。
2. $someGlobalVar 声明如下：$someGlobalVar = array(); （不使用 phpDocumentor 手册中的超全局数组）。

PHP代码：

编辑：我想按照手册所示记录这些全局变量，但我不确定如何/在哪里放置 @global 和 @name 标签。

编辑 2：我最终在声明 getSomeProperty 之前使用了以下代码段：

我使用 phpDocumentor 语法，以便NetBeans IDE在源代码中显示内联帮助。在 NetBeans 中似乎一切正常，但我不确定这是否是正确的方法......

任何人都可以确认它可以吗？

我们必须如何记录（使用phpDocumentor ）用PHP 中的define() 定义的常量？

我在文档中一无所获，但在 sample2.php 中找到了以下示例（我没有看到它的用途）：

任何人都可以告诉我用 phpDocumentor 在 PHP 中记录常量的最佳方法是什么？

考虑以下 PHP 5 类：

我将如何在phpDocumentor中记录 $foo 属性？我什至不确定它是否需要记录在案，但我想知道如果需要如何...

我知道如何记录 SetFoo() 和 GetFoo()，我只是不确定私有属性（变量？）。

谢谢！

netbeans 是否包含 phpdocumentator，以便您可以评论您的代码？

是否有一些关于如何使用它的指南，例如。我应该如何评论，如何阅读以及如何打印出来？